diff --git a/.version b/.version index d43f5946..805579f3 100644 --- a/.version +++ b/.version @@ -1 +1 @@ -v2.10.1 \ No newline at end of file +v2.11.0 \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 26fd1bde..adfcbd3d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # Change Log +## [v2.11.0](https://github.com/auth0/auth0-angular/tree/v2.11.0) (2026-07-20) +[Full Changelog](https://github.com/auth0/auth0-angular/compare/v2.10.1...v2.11.0) + +**Added** +- feat: add support for Online Access (Online Refresh Tokens) [\#934](https://github.com/auth0/auth0-angular/pull/934) ([NandanPrabhu](https://github.com/NandanPrabhu)) + ## [v2.10.1](https://github.com/auth0/auth0-angular/tree/v2.10.1) (2026-07-08) [Full Changelog](https://github.com/auth0/auth0-angular/compare/v2.10.0...v2.10.1) diff --git a/docs/assets/hierarchy.js b/docs/assets/hierarchy.js index 1ddc33e0..713cc307 100644 --- a/docs/assets/hierarchy.js +++ b/docs/assets/hierarchy.js @@ -1,2 +1 @@ -window.hierarchyData = - 'eJyVlEuP2yAUhf8La6ZDjLHBuyp9qFLaqabTdjGaBXJuYjQEXCCLapT/XjlRp9hOCllFcs71d859+AU5a4NHzWMpBKaCYsrqJ4wcbDS0QVnjUfOCKKuHHyN3gBr01fb7fmW3ytz1JwlGz8qsUVOwCqO906hBygRwG9mCv53p33RhpxFGrZbeowYFv74ZXnDzWjT82Sm9dmBQ80gr+nTAiFY0cvERwoN9BvNThe5IyDNzqSzD02BBxBY+LWXbQQJ4El0buSRiiFwSEfFWtpX6W7BObmGMXhT8L/pIAH87E1+0cHow0IQYNdiAU+1756z7HyjWJRijiKwoMStrXJEFrooSV4ziqua4JgxzwjFnbGgBK8rI1IPagd2HpKlYd5WpujpCy3jhP2/kPfzaKwfrJHiqTXed1dX0uHJTzsRpWkUWU9pdDyYP9arM4IzG9nYfOjBBtXI4tiTsjDyDyOg02VKaFrTOGNsZeQax5vGWKO+V2d7DxoHvjh+Z9LZcqEmza8Ii9tIaA216YWJdmsFJnO+7h3e97b9Y00ISNBNn0Bgb31zOrV194JwTLAjDghIsGMOCk+HgOSdj+Er5EK2hdT7HzoWqdHhBpuGNs1rvwKSHOldn8Ogk77KTWoPZpkc7E2fQpqP9AU5tfuegImUGZzrFf335INvcIZ4vStEPhz9XOxV1'; +window.hierarchyData = "eJyVlUuP0zAQx7+Lz15Im6d7Q+UhpMKi3QUOaA9W4jTWunZwHCS06ndn0orFSRo8vcRR/B//5uXJM7HGuI5sfqRRRGOW0DgtHimxolaidNJo2Hsm8HFYND8IsiFfTNu3O7OX+rY9Syh5kroim3WaUdJbBSKpnbA1L0X3eqZ/1biDAqNS8Q7OJ66rboYDbl6Mhs1GqsoKDb7FWfJ4pAQWz4sPwj2YJ6G/S9ecCDhnlswQPg0uMN+Fj1teNiIAPIuuDTlZRUPIsHi8nSm5unfG8r0Yo1fr4i/6RADuTLzowvkD0KAHRgnWwsrynbXG/g/k6wKMUYjpOqVpUtAsWtMM3rM0oVnOaB5lNI9jmqeMFtmastWp+iD3nHuQB2F6F3TO113lXJ6foInf+J9qfid+9tKKKgieahHZz/PpJcNGOROHaZD1Ke22FRqHelEiOKOyveldI7STJR8uXRB2QY4gpsk0si3XpVAKUbYLcgQxZ36XyK6Ten8naiu65jRswt2yYBNmw22Zs+9L04oOS/XUCF4c+xNQ/+JKVluja7nvLa6qi0YIeupnGk7Q8JcKAn1dmAEzx2N87cTb1rSfDbREEDQTh2kw3cYTBjNZrh5nLGaUZQllBaOraJXAI2bDgIONMX4nO+ddO2MRbbRohQg/m4avrVHqAAehEjFWI3jFJN5tw+Gm6324uDNxmDakeoz7Br/K+jeG5SkxoGkd/2XmPS+xZbxsFMIfj38AbnJpGw==" \ No newline at end of file diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css index 4458137b..7ddc24eb 100644 --- a/docs/assets/highlight.css +++ b/docs/assets/highlight.css @@ -96,4 +96,4 @@ .hl-8 { color: var(--hl-8); } .hl-9 { color: var(--hl-9); } .hl-10 { color: var(--hl-10); } -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 b34bb1d9..4e65a115 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "eJy1m11z3CYUhv+Lrp3GcZu09Z1nkzie8dqetZNcdHqBpbMrJlpQAW2z7fS/d1aSdxGCAwLlmve8zwHxJYT++DdT8F1ll9knpeolqJIX2VlWE1VmlxmwZitfn0p+KtW2ys6yb5QV2eVv/50do1cga84kPO1rMOP1MsPhLMsrImV2mSlZvKLyFXxXIBipMs376lkqQXJ1R3Z0QxQXJ0AbDfL1SDLkvLnQc71qVHm+qCgw9ZHkiou9xXCk8Tl24gVna7qx++kKnxswRXOiKGcfhLDWeCwaeYa1bqPK64aIws5oi3zZHnrIDVMgcqjtz2cs8nkuedFUYLfqynwOjyB2NHdY9IVeD0WUy+FQhMUvOGOQK8cD1EvjntxHUHkJFuu+IM71GhgImjuy1kvj/G/YErZc7BckLy0tOyiOI9zynFSPiguyAQdlJIkjLddkUZKqArYBR4ONJNGkD0zwqtoCc/WosWYGVjf7yRCkLo0nu0FJvrdUKm3ORKvk0EazV/BXQwUUbuJAEc35AoKu926KVh7JoFJStlnBWoAsn/g3cC1PLmUkd3+V57xh6qqmLqApiSM9ECm/wd43qq2yJCIOSve/BoU9L5sqibeCDZUKBM4bqCJ5vG7qBWE5VJVziFlECbT72t2Og/IExhPdAm9cU/1IEkfCIen+nyW8r3l9x1nuGkkjSTTJbh67K65rY+tHD1vXNckPu7++cGh98fad+UpgvAzoFsdin8lxEXL6HBUjq+AXAC7oP+2LxAMRZCudKEMXBzzOmoPkETIWkJjCy7spzn1RxcE+bAmthu9r5ou2BnWqE+CnPdqxSvf1wdne3p6YeRNBn4AvaJZUum3RhAYZBESm0Jq1vkjHH6lSYKctOsI6iVJQ96r21uqoSQE9NLL0kk6iFNTjVnpJR00K6AunOXhRmioOhnSFlA7wsoN8pBUwVaHDyqFNA3+lqux3YX6yKY5DGydbyLJvVWI7ACNgxRsF4f6aHIPcGKckmuGN5XQktFluiraN7b5dWZzxLd/wRmHPd6DAqq6/Nnbns1a/sSwu8/tnCWJHnitYrgmOtEuxumgRYbXCAsJA/WtcKMaUoxD+fFqS0E2CVRn5fFQdCrUp46BBjehtukmo0M0ook9KYCGgtcLGsF2aii0O9SAV+myd6iT4xE24N2ruZEKaZPat+MjXvxnHQ9LSOBxABLWDLkxC3vINZVM6hDVgxhRCqm+PSEricAIOEl3Urcok6CPdsKaeVHVHSHwaf3NRTJqPXQFpKUTMTnjY7Ol4n44nbq6EwmYoJCYykZIzCO8oLnUCfGoXwWPmTQTvHJ6gWVIJ6BZIQGQK7WeN9v0OBY9kCbh27vfSdFUkrJHlHVd03Xff8K4fEDhPSlMHRHD4D0sPHybh8XMnGDB4wmLjEltBzncg9gtehE+xvqD0VCb2r7DQH5IW2q8CY+dMzN+fAuJiEyqogFz197v6cxU8FSQiLQnvZG0TYqcyT1zVwSPEJY6r08Ft4ojAQ2ZNAx0Bnpg5EvH3eEQfl8DnuiDKOvX1r2jWNLxRccl09UE+m+iCOMRXeD6kzR4qotZcbIPHQUhgWkorTraUbSZnhMRFXiaoafvR4T2sKaMHtxNf7ev28oSpMEjnv//65u2F8z60Wave1V+Dzjf4SoTpNrzZ7qaOb7lHkrnwIDtBPKv9tHM4ljcZx4IE78Fa9rLKrEA2lRrhEG1yBlD0vg7qsdzXCxeNVHzbXq1eUka3pLpvVN2MfR26hJq0jt29vO95SWyLns62KePpIUtuRw9eadPo45XWiXcssFF8P3ZOmmM5N5HYKj6Zay6eOsy6bk4g9L8kmJ+uO8SgMJ7RfvgmuaK77ibhJ8KKSr8W2NEcsnjuck26GxO2+XpQmMS4FoQpB+JYFk+458+LkjAGlel/Kol31z8cOHq1RZLMM07rcbJdPFMOIehkYjfzs6Lm1D1hWUVpO5b+T7nRD1c7IuhhHzH4n87659XP5oavmww8jgMRYkhefmT7qG1H1w3L2/Z+rRUPTd79YpgY92vcdiMhYkxlyC2fkz+mRzC14DvaHVWd22z18pHNn/8DRid4+Q==" \ No newline at end of file +window.navigationData = "eJy1m8ty2zYUht9Fa6d2nCZts/MotuMZy/bITrLodAGTkIQxBaAgqEbt5N0LXiyBIHAAAsxW+M//HRB3Evrzv5nE3+Xs4+yzlHyB5Ybls5MZR3KjfsO02panx5JfNnJbqOIXQvPZx99/nByil7jkjJb4ac+xGa+XGQ4ns6xAZamksszfkPKNcsOComKmeV88l1KgTN6hHVkjycQR0ETj8nQg6XPenuu5XlRyczYvCKbySsUwsbcYDjQ+x1Y8Z3RF1nY/XeFzU0KSIUkYvRTCWuOhaOAZ9nSV0XWFRG5nNEW+bOseckOVd4a5vX2GIp/nguVVge1WbZnP4RGLHckcFl2h10Mi6XKoi6B41dIUZ9LRgHppXMtdYZltsMW6K4hzvcYUC5I5stZL4/xv6AJv1XiaI5XjENArjiXsUEHydqBVAhpFTmkc+ZZlqHhUnRutsaN+A0kcabFC8w0qCkzX2FG3gSSadEkFK4qtmm7cKEMzAaudd8sQpC6NJ7tBSb63pJTabA1WyaGNZi/x3xUROHcTe4pozlc1Kaz2bopWHskgZUnoeolXApebJ/aCXUPapUziPmaMY2e7DTSRrP1FlrGKygtOXChTEkd6UIoXvPfNIFZZEhEGpftfYwn1DZsqibfEazVisYB5PVUkj/GKzxHNsGoK13C2iBJo99z9HHvlCYwnssWsci0rA0kcCYak+38p8SfO+B1TD94BGUiiSXbz2L0/58YGl9Qb9BXK6j1uV9i3Pn//wTz4GEce3eJQ7DM5LHhOn4NiYBV8zGGC/Nts8R6QQNvSiTJ0ccDDrNlLHiBDAYkpvJ7AYe6rKg52uUWk6J9KzdcJGtSpToAf94OHKt3z2tn+vD0x0yYCtoAvaJJU2i3YiAfSC4hMoTFrfIGOP1ClwI7HAYB1FKWg7iX31uqgSQE9VOXGSzqKUlCP29JLOmhSQF8ZybAXpaniYEBXSOkArzvIR6IGqizAYeXQpoG/EbnpdmF+simOQxvv74Bl36qEdgBGwFLtx3C4vyaHIDfGGxnN8MbyJib0sdzkzTO2+7Zlcca3bK0qBrVvTwFVXT82tm+hrX5DWVzm989qR7pDzwVWR38YaZdCddEiwmoFBYSBumNcKMaUgxD2fFySwE2CVRnZPpKHQm3KOGjQQ/Q+ulGo0M0ooE9KYC5wYwWNYbs0FZvX9UAF2LZOdRJ85CbcGzV1MiGPZPKt+MDXvxmHQ9LSqF9ABD0HXZiEVCsVoWM6hDVgwhRCqm+PSEqiftuOS3BRtyqToI9kTSs+quqOkPg0/mEiHzUfuwLSUoiYneCwydPxto4nbqqEwmYoICYykQ2jOLyjuNQJ8LFdBI6ZNhG4c3iCJkkloFsAAZEpNJ81mvMdCB7IEnDN3O+l6apIWFVu7pgkq677hnf9gMBpUho7IILDf1p68DAJj586wYDBExYbl9gSZ2yHxX7O8vAp1heUnsrI/hUW+lPSAvtVYOyUifn7U0BcbEI5ETiT3S227r0KnAoQkZaEd7K2CaG3Mk9M8uAR4hLH1al2Gzki4JBJ0wBHgCdmikT8PR7QxyXwhedIWqe+7ohmTcMbFZdMWx/gs4kuiEN8w8912vShQHLFxDZ4HIQEpqW0ZGhL6Hp0RkBc5GUCTpqPDp/wilBSux35cs+byxOmwiCd/fHb2/fnzlvfZq06V38NWt/gKxGmW//+vps6vMsfSWbCg2wF8azm0079Wt5kHAoSvHtr2esqoya8qpADHKBNzgDnna+Deij39cJ5VUq2bS6QL1TH3aLivpK8Gvo6dAk1aRzbe3nfsw2yLXo626aMp4csuS09eKVNow9XWifescBG8f3YKWmO5dxEQqv4aK65eOow67o5gtD98cL8dN0ieoXxjObDN8ok2bU3CT8jmhf6tcCW5pDFcxcr1N6YsM3XvcIkxrVAVDoQh7J4wj17VuNGzYmF6X8siXfXPxw4erVFkswz3tbDZLt4ohxC0MlE/Wr/Qh1sTZpZHk9q1xiac0bcU6NVlLY36v55OPgD2w4JUu9Yev9PtP6T7Z25tWynHY9jTwQYulvg6Ae3wruwh4Fe/4F4pe2wVxXNmi50qhX37T/8apgYV4bcdgMhYEzKkItLR39ID2C4YDvSvn07s9nq5QObv/4HtG4SXw==" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index 91b2508b..0104db09 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "eJy1nF2PnLgShv8Lcy5bSQO2gbnLmeyXlN2Nds/Zc9GKVqTbPY3CAAJ6dkdR/vuR+azCBV3N9F5NFFxvlcuPC2Nof3XK/K/Kud99db4k2cG5DzdOFj9p5975sa6Ln3V9yg/OxjmXqXPv6Oz8VL0dL7w51U+ps3H2aVxVunLuHefbpldy1SD1Xqe61ssyd4e+EVDbOEVc6qzG4ZA+ftD1BQePTYt16j/q+EIa7k5tk3X6H+N6f7rgoOjarPSQV5cSVLRNVuqfL8qfr1X3Rhrffa7qMt7Xv8TPyWNc5+XgrBN8a7VYpFO63qC9z7OqLs97vuodNqH7ZIc8uve2Yuxb1jbQ/375b5lyI+iNPr+cy3RVDCi95/q0fUgTndXfx6ZXL3YcVpPbJJiW5WXYjnomxftSx7Vum/JDaIz2vdGKGKYpbts95NkxeSTDgA1ull5LlJ1cFO9Mah81nVHb61IB5nqr2N6qdd6mQ/bDOS4PpMvmys0GaVRjj04b2hzxcfZuXyfPMbjxzvmLs3hs+np/D6ckvZQy6HTftV/v+UMecxym+cItmvIzhcHcpn7Kal3udTE3kJM2NwOE0mWjMg18JpVJ34QfATRZ43+a4p/zwzmlkW0v3SyhQI6dxy66mfQd8/K3PKeTB70d87Js213haZqo33X5nOzpTHXXbpYqqMfOVR8g6MLWE4PPuCh+r+Na/+uyx7goqvpSdbrgTpdlXjJ8Ne1e4yg5/Cf/orOHNE6eKobD5FCb9vum/ascV6aRzupkH9f6wHFdxdDidc5NDU6yR5bbtG37GodPx/iyp7bReh8v7/b7/DyzZMSeXuKh6Wp/RVxVXzS99EbexoarfZ0rzZkOptmVbvDNOc8yva+7PP4vqU+/6UNS6j0jp51tl9i/kvpUjrbrI2pW9d/ren/SnGrXND8OzVf7fdSZLuNavy/y4mOZ58fLvnuTQ5EXRWfyCv9mFHRVNeXp9yTVWZ0yWHvUZgR0VTVlqhrtbhSJYeJjXpyLa0MxQBSd4WtiMQPyS54xbqUmADMWWdd6tddTnB1S3c+EhzhNP8f7L5f9t3b9LNiPdqsjSfPHpBmCh3NV50/NiHz39/4UZ4+MfDTWZhz2jXUzLHq0fn1UTDCGOF7Nw+CZX6YG57eoTmn+mJ95TvOF/TSGp+zx1+y9ruoyZxSB7DHPDkPj1T6rq2ZbtX62WYvleu45uLlyu4XyoMZfJjehrVi1jq4Ya9YlJ5wV6+jsivXqolPWahW4vWatuux4eaUKXbLWqUvOFlZZo5/La6yJCzSnSn0sdXW65GRsttJPhe7al9xV6Fb9Kq/fdXRf8nf9LJh6+qlHg+FtHRyeHN+YvOsegAdnzVbKMd4bf9215TdskLRusawP00eWOdW7weLik0sf6IzrUldFnlX6z/qluNybu2nzdU7ruIQ7z7PehnZsN2iMzEYx3q6Hnoar/HFqKP0Y1yeGYFvYi7bxwk62tYcNHZ5m9iwX3BqTBJmsdV59SYrZZe5CBMbuqmWu/dYAjOJk93F+QMmG/LGN0zT/Sx8+JBUJ5rz6XWeZJhfewNq9YPX4t/xca3a3Qesr+/4uy7OXp/xcrfDS5iAGCqw0wK4tzIDJlwxXhGWsn3rrW4XU3BV/Leokz1blqrHPB/tbhXUukzXRtGY3DOLnGO/OXBfLU7y8WcMKCc6mD83D1sJwoQaLcwbK/vq50uVz/DnVPx/jd0UyeT0N9OmWy47QntcpTlMNH+l54nfQkE7mTCdmAtFZmafptVEMVrcIwew+jU8SeUkO6FI0ZhdqKnCjwL5rOvo0fEuwJjY9aBwHjVuE96zL5PhybUCD1doQ6PnSb8xzZ43Vnj932u/SADJJns3fTS767L5zi5HehfvLYscXZ5rB4IE5+WfiHYWuKgYrAv2DQ9jFKPnEsUPEJeOV44/Lxz8z+DMBXyon10XMKizXhMyrefNBXlHv2GGdi0N8y9nf6v0jAJCV8mP7ppBZJ6et+VWy2QRfIX7XG17qu9WRuW2c5DEDrwyuiGSwfE0oYBD6594PpocLi0eq3YXER4Erx03pd0XSrGHf62OSJcZ+cGO2WMyOyLTBVfoPc1tLrfr08qK2D8Iev5ycfsvyHJeJyTT6NpPzUctEvl3VL6ujNoviCjzt9h+LfT/m+njO9s3gvQVXrxGcPJfMSlvtuE6SirEvMPpaas51WZT5c3JoCuiWcAEvU5KfNk6SHfTfzv1XswCtDNv3jvfGfxM5G+eY6PRgfr3Qets4+/zpqS1yh3x/bv75qWv2h25vDve7tvXbrbPZbTd+8EYq+enTZtcbNxea/+g1xv9pDF1ns3M3wnujAoEMXcvQRYaes9l5lEfPMvSQoe9sdj7l0bcMfWQonM1OUIbCMhTIUDqbnaQMpWUokaFyNjtFGSrLUCHDwNnsAsowsAwDZBg6m1248eQb3wuRYWgZhsgwcja7iPIYWYYRBsDw4G5JBGx43Ak97ly8LsEPBsg1WLg0ezZDLobINWi4Hmlsc+RikFwxG7WNkotZcuUc965Nk4txcg0kLsm+axPlYqRcA4pL8u/aVLkYK3eWK9cGy8VkuYYXl5w/rg2Xi+nyGrrIOeTZdHmYLq8pTuQ88my8vEl9avAKSWOiRGG8PH8uX55Nl4fp8gwwLjkXPRsvD+PlNXiRs9Gz+fIwX56ajdrGy8N4eQYYj5yNno2Xh/HyDDEeORs9my8P8+VFs1HbeHkYL98A4/nUdPRtvHyMl2+A8QRpbOPlY7z85v4nSWMbL39yCzTEeIo0Ju6CmC/fEOMFpLHNl4/58hu+yFnh23z5mC/fIOORZPs2YD4GzDfI+CTZvg2YjwHzDTK+S/bZBszHgPmGGZ+k07cJ8zFhwjDjkzVb2IQJTJgwzPj0msUmTGDChGHGJ+uusAkTmDDRrLLIuitswsRkoWWY8cm6K4i1FiZMGGZ8kjBhEyYwYcIw45OECZswgQkThhlBEiZswgQmTBhmBFn/hE2YwIQJw4wgCRM2YQITJg0zgiRM2oRJTJg0zAiSMGkTJjFh0jAj6JWxTZjEhMnZW6S0AZMYMClmK6+0AZOT1bycrbySWNBjwKSarbzSBkxiwGQwW3mlDZjEgMn5EiZtwCQGTDaAkdNZ2oBJDJhqACOns7IBUxgw1QBGTmdlA6YwYKoBjJzOygZMYcCUP3tvVzZhChOmDDOSfCJWNmEKE6aaB0ayFiibMDV5ZjTMSLIWKOKxEROmDDOSrAXKJkxhwpRhRpK1QNmEKUyYMsxIshYomzCFCQsMM5LEM7AJCzBhgWFG0k/LNmEBJiwwzEgSz8AmLMCEBYYZSeIZ2IQFmLDAMKPIu01gExZgwgI5t18T2IAFGLCg2ZUg6QxswILJxoRBRpF0BsTeBAYsMMgoks7ABizAgAUGGUXSGdiABRiw0CCjSDpDG7AQAxYaZBRJZ2gDFmLAQoOMIukMbcBCDFhokFEknaENWIgBCxvASDpDG7AQAxYaZgKSztAmLMSEhYaZgCQstAkLMWFhs/dFEhbahIWT7S/DTEASFhI7YJiw0DATkISFNmEhJiwyzAQkYZFNWIQJiwwzAUlYZBMWYcIiw0xAEhbZhEWYsMgwE5CERTZhESYsMswE9K6hTViECYsMMyFJWGQTFmHComangiQssgmLMGGRYSYkCYtswiJMWNTshJGERTZh0WSTNZpdVUTEPut0o9VAE9I7eFtqq3Wy17ptNlvpjbgtsd26ney3bg06IUlpe21qP9ly3TYrfhLU9trUfrLrum22XUlW22tT+8nO67YhjsS1vTa1b/+veevyrMtaH35q377sdk7cHSWTjSfwfHX+7N7OBP0Ln69O4Nx//fZtfBdz//UbeB1jrhmf0489Rym1BVqCL9Z/PTsqyRAoeTylIinNS64DeJU6Cob+KBiFTMH+p+ujjAdk/G1rqHyenHlR1p5Ic+zP6RmFXZA6d3utYNW/JgUdFlCQr9gK7rsXiyBAD+jxe2wLSZBCxSRuEKI6KmFHXbbgY3s6DOghzBg/sEbniGFTMCQmvuf6ZH28D4IDE8JbrTgJM4Bh8sf0qTvnA0wLQK8n2ULEaHoAM485T43SdKIKQIXk5QudpQMyD/mKrlXqDsgBcoANjzcth+NvgAoYOo/HPPgEEFRsEE3I1Fn4af8o7INx9JlZs37UBIoGAEyJViBiy44/5gTwg463lq7b/e303e7/Pb/7q7q/UftX8mYMPooMDKELuGISig80ANkGNVXwoOrPbAQBgXiukKA/iAPrC0BCyCur/UfjgFPAe8hLFvnxKwgLpCzkFRr7Q1UgB24eIQ/M7kePoPYBDb+DUfKWUeDXZmDSAD3F6+JwvBGICnDh8caPOPwCsAqiEjzQml8BgohAQN1U5d1z5s7DAMGBYi94nM2ebAFUQZUVvKox+6kxQA7EGvEm/fznwEAWBBuxx2f6swowdWGlZXcenB4A8giqgOBNDPpXFSC6CETHliSEAhBbxCNn7kgQ0GGQO8FjvD3LFkiAmsITmF+ESkCc4hW5iRrxOACfP3m4TTSbpz5CGIxswO+6Pc/A0qN74gt4QzE5bgEUMJBHvythkqk5ntkH7tygqx4PYutMBhAdKAB+t/aRiqnKG5sQcG12Pnjaw6/2QayAHr9bt0neTar7eh0EBQY64o3G8iE6YBKCARK8VE7PxQGPNiBOcUVf55bqAtzgBW+Z0B9hA0TATVnwSkMrMvwSFtRksEIIeFrNaXEAC8CXzxtKcAoc0AHj5vPGbXK486gFpHh9Qgf3gEyDii55t/18+P3D0zGOi8R+GFGgIoVXi/apI6UDgFfIy+Eo3Z2WRwvDjPJqyHD4HpiaYDb5vNnUneYOhgSwz1PIJ9udYEh5Au3H93H7bT6oYREsrEwtPJNB9eeNVl9TmiJDTOcQlIaIl+HhxBuQYxCX5E2gyWklIN0AScVLUoUfQVwwCV1emqbH6oCugZuY4k2+amaFLACKkreaGo/fATKgfiq2DHmHFoBIxVsX97/mAgiBAYuY6SaPIQEMAJ4CXtL782iACEBb8eLCxz+AaQe6GPCkln6QCMokGMuItw5uDoUAoYFeBrwJDI9yAEJg1gS8lUZ7wBYo1yBNfrdBJ3lSxKYNqP0how582jhFUug0ybRzv/v07dv/ATa/WzQ="; \ No newline at end of file +window.searchData = "eJy1nFtz27YSgP+LfB49iQjiQuYtx+ltJmkz6Tk9D55Mh5FomxNZ1IiSW08m//0A4G2XWFIrWn1pKhN7weLbBQiS+LbYl39Vize33xZfi+168Sa5Xmyzx3zxZvHz4bD7kB8eyvXienHcb+yf8u3xsXrdX3j1cHjc2KurTVZVuVWzWHy/bjVFulP1Lt/kh3xazdW6bQS0XS922T7fHrA7pI2f8sMJA/e+xTztP+fZiTBcPdRN5un/mB1WDycM7Jo2My2U1akA7eomM/UfT6o/nqtd9DS+/VId9tnq8Gv2VNxnh3LfGWsUvg5aTNKpItHpXpVbK3pc8bVeYRG6T6HLvXmxlH3ftnWD/N/P/91vuB60Ql+ej/vNLB9QeI+Hh+XNprBSP2auV8+hH0GTywSYVsuLcOj1SIhX+9zGqm7Kd8ELrVqhGT4MQ1y3uym3d8U96QZscLHwBkrZwUX+joT2PqcjGlqdKsBcaxXbWjXP2nDIfjpm+zVp0l+52CD12tijU7s2Rny2fbs6FE8ZmHjH7GXbrG/6cns3D8XmVMig0VXTfr7l92XGMbgpJ6Zoys4QBjdN/bI95PtVvhsbyEGbiwFC6WWjMnR8JJRF24TvARSZY38Y4g/l+rihka0vXSygQB07jo13I+G7K/efypIOHrRm2+3rdmdYGgbq93z/VKzoSDXXLhYqqI8dq9ZB0IWlkJ3NbLf7/WCz/1+nLdqm1eFUdTphLrch3zNs+XYvMVSs/1N+zbc3m6x4rBgGi/XBtV/59i8yXLlGtnmxsrFac0xXGZR4mXFXg4vtPcvspm77EoOPd9lpS3Wj+Tae365W5XFkyYgtPWdd09n2dlbua04vvZG1vuFsW8cq56SDa3amGTw5l9ttvjo0cfxfcXj4lK+Lvf0Tq9A42Sawf1nZfS873yO/qv8xtzfTOafa+eZ3XfPZdu/zbb63qt7tyt1HW/7vTttuRdZWZNeIvMC+G4W8qnx5+r3YWMkNgzUrl3k5X6aqXu5CnjgmPpa74+5cVxwQu0bwJb64Afm13DKmUueAG4tt03q21Ydsu97kbSbcZJvNl2z19bT9Wq7NglUvN9uTTXlf+CG4OdqoPvoR+eHvlTV0z4iHl3bjsPLSfljyXvrlXjHB6Px4MQ+dZX6Z6oxfojpZZeWRZ7Sc2E9jWNre/7Z9l9uVXMkoAtv7crvuGs+2WZ2VbdX8bAsWy4ex+2B/5XIL5U4bf5nsXZuxau1NMdasU0Y4K9be2Bnr1UmjrNUqMHvOWnXa8PRKFZpkrVOnjE2ssno7p9dYAxMop/b53T6vHk4Z6ZvNtFOhWfuUuQpN1S+y+kND9yl752fB0NIvLRoMa/PgEKp/YvK2uQHujPmtlLts5ew116afsEHSmsVyvh7esoxpveokTt65tI6OmLZc7Wyxy/88PO9O9+Zq2Hye0UO2hzvPo9a6dmwzaIzcRjHeroeWuqv8cfKUfswODwyFdWHf1Y0ndrKDPWxo8GFkz3LCrBMpkMhc49XXYje6zJ3wwMmdtcwNnxqAURzsPo4PKNmQP7bW0fKvfP2+qEgwx7VfNZKb4sQT2LAXrB5/smvFnN1t0PrMvr+1a7Xnx/JYzbBSxyADGlhhgF2byIDBmwxnuOWkH1vpS7nkZ8XfdofCFsI5Tnn5spO/lFvHfTHHm1rsgk58yPDuzHm+PGbTmzUsl2A2vfc3WxPDhRpM5gxU+9sXu/B7yr5s8g932dtdMXg8DfTTLacNoT2vB5tcObyl5ym/goJ0MEc6MeJIvt2Xm825XnRSl3DB7T71dxLlnhzQKW/cLtRQwYUc+8F39LF7l2COb3mn467TcQn3nvJ9cfd8rkOd1FwX6HxpN+a5WRO05+dO/V4aQMbm+PhsctJm855bhvSdmF8mOz6ZaQ6DG2byj/jbKzqrGMxw9A8OYSe95BPHdhGXjBeOPy4f/8zgjzh8qpyc5zGrsJzjMq/mjTt5Rr1ju3XcrbNLZn+t7x8BgKyUH+snhcw6OWzNr5J+E3yG8qtW8FTfg46MbeMU91vwyOAMTzrJl7gCBqG9733vejixeKTanQh8aiLVb0pbR/wa9l1+V2wLJ9+ZcVssbkdk2OAs/TdjW0u19uHlSd0xcLt/c3L4LstTti9cpNG7mZyXWgbq61X9tHbUZlK5Bne77ctiP/axvjtuV37wXoOr5ygc3JeMqg7acY0UFWNfoLc11Zxrcrcvn4q1L6BLwgS8TKn8fG0zZZ3/vXjzzS1AK8f2m4V4Fb9Kbcu7It+s3dcLtTUrWj4+1kVuXa6O/n8/N83+yOvJ4c1t3fq1ded2eR2bV0qrz5+vb1thf8H/odXR/8ULRvZXdC3FK20kEowCwQgJCvtLUBZFICiQYGx/xZTFOBCMkaC0vyQlKANBiQSV/aUoQRUIKiSo7S9NCepAUCNBY38ZStAEggYJJvZXci3Uq1gkSDAJBBMkaAm6TSmLaSCYYgAcD9GSRCCEJxrQE435GxH8YIAih0VEsxcyFGGIIodGJEjhkKMIgxTJUa9DlCLMUqTGuI9CmiKMU+QgiUj2o5CoCCMVOVAikv8opCrCWEWjXEUhWBEmK3K8RGT+RCFcEaZLeLrIHBIhXQLTJXxxIvNIhHiJQX3yeCWkMFGiMF4iHouXCOkSmC7hgInIXBQhXgLjJTxeZDaKkC+B+RJ61OsQL4HxEg4YQWajCPESGC/hiBFkNoqQL4H5Eumo1yFeAuMVO2BETKVjHOIVY7xiB4yQpHCIV4zxiv38p0jhEK94MAU6YoQmhYlZEPMVO2KEIYVDvmLMV+z5IrMiDvmKMV+xQ0aQZMchYDEGLHbIxCTZcQhYjAGLHTJxRPY5BCzGgMWOmZikMw4JizFh0jETkzVbhoRJTJh0zMT0miUkTGLCpGMmJuuuDAmTmDDpV1lk3ZUhYXKw0HLMxGTdlcRaCxMmHTMxSZgMCZOYMOmYiUnCZEiYxIRJx4wkCZMhYRITJh0zkqx/MiRMYsKkY0aShMmQMIkJU44ZSRKmQsIUJkw5ZiRJmAoJU5gw5ZiR9Mo4JExhwtToFKlCwBQGTMnRyqtCwNRgNa9GK68iFvQYMKVHK68KAVMYMGVGK68KAVMYMDVewlQImMKAKQ8Ymc4qBExhwLQHjExnHQKmMWDaA0amsw4B0xgw7QEj01mHgGkMmI5H53YdEqYxYdoxo8g7Yh0SpjFh2t8wkrVAh4TpwT2jY0aRtUATt42YMO2YUWQt0CFhGhOmHTOKrAU6JExjwrRjRpG1QIeEaUyYccwoEk8TEmYwYcYxo+i75ZAwgwkzjhlF4mlCwgwmzDhmFImnCQkzmDDjmNHkbGNCwgwmzDhmSDpNCJjBgBm/K0HSaULAzGBjwiGjSToNsTeBATMOGU3SaULADAbMOGQ0SacJATMYsMQho0k6kxCwBAOWOGQ0SWcSApZgwBKHjCbpTELAEgxY4pDRJJ1JCFiCAUs8YCSdSQhYggFLHDOGpDMJCUswYYljxpCEJSFhCSYs8XtfJGFJSFgy2P5yzBiSsITYAcOEJY4ZQxKWhIQlmLDUMWNIwtKQsBQTljpmDElYGhKWYsJSx4whCUtDwlJMWOqYMSRhaUhYiglLHTOG3jUMCUsxYaljJiEJS0PCUkxY6ncqSMLSkLAUE5Y6ZhKSsDQkLMWEpX4njCQsDQlLB5us6eiqIiX2WYcbrQ6ahN7BW1JbrYO91qXfbKU34pbEdutysN+6dOgkJKX1taH8YMt16Vf8JKj1taH8YNd16bddSVbra0P5wc7r0hNH4lpfG8rXf/NPXZ7y/SFf/1I/fbm9XWTNUTLb/gSeb4s/m6czpn3g821h7H++f++fxdhf4HGMu+ZsDl/27FXZBUKvS/KVtW/P9ppUAjQJnqZdsXcPudbgUWqv0CZBp9ByzlPYfrreqxFATbysBe1inKXOPSirT6S5a8/p6RVHIHTR8lyFVfuYFHRYQoV8jbXCVfNgETgogD5+j0NFCoRQM4nrFFEdVbCjEVvhfX06DOghjBjfMa/nDsOmoUtMfK2q4OV94BxICDFb48BNA93kj+ljc84HSAtAr1BsRcRoCoCZYOap0zRMVAmoULx4obN0QOQhX+m5mpoDcoA6wIbgpWV3/A3QAoZO8JgHrwCCig28SZh6Jj7t7xXHYBxjZtSCj5pA0QCAaVkrSNlq+485Afyg47VkFDX/Nvqj5u8ibv7Vzb9p/a/iZQw+igwMYQS4YhKKDzQA0QY1VfKgas9sBA4Bf85QQb8QB9YXgISEV1bbl8YBp4D3hBcs8uVX4BYIWcIrNOGLqkAdmDwSHpjNR4+g9gEdcQOj4i2jwNdmIGmAPs3rYne8EfAKcCF440ccfgFYBV5JHmj+K0DgEXCoSVXenDN2HgZwDhR7yeNs9GQLoBVUWcmrGqOvGgPkgK8pL+nHXwcGaoGzKXt8hp9VgNSFlZbdeXB6AIgjqAKSlxj0VxXAuxR4x1ZJKDLAt5RHztiRIKDDIHaSx3h9li1QAWoKT8H4IlQB4jSvyA20EbcD8P6Th9tAp7/rIxSDkTX8rod5BpYezR2f4Q3F4LgFUMBAHOOmhCmmzv7MPjBzg64KHsTBmQzAO1AA4mbtozRTK29sEsC12/ng6e6+2ge+AnriZt2meJNU8/Y6cAoMdMobjelDdEASggGSvFAOz8UBtzbAT3lGX8eW6hJM8JK3TGiPsAFKwKQseaWhVtJ9CQtqMlghGJ4uf1ocwALwFfOGEpwCB/SAcYt54zY43LnXBVTx+oQO7gGRBhVd8ab9svv+wcYp2xXhzYgGFSk5W2kbOlK1AXglvBj2qpvT8mjFMKK8GtIdvgdSE2RTzMum5jR3MCSAfZ6GcrDdCYaUp6B++T6r380HNSyFhZWpC2cyqP680Wprii8yRDonoDSkvAh3J96AGAO/FC+BBqeVgHADJDUvSBW+BYlAEka8MA2P1QFdA5OY5iVfNbJClgBFxVtN9cfvADWgfmq2GnKGloBIzVsXt19zAYTAgKXMcJPHkAAGAE+GF/T2PBqgBKCteX7h4x9A2oEuGp6qqQ8SQZkEY5ny1sH+UAjgGuil4SUwPMoBKAJZY3grjfqALVCuQZjiZoNO8VQRmzag9ieMOvD5erErdvmm2FqR28/fv/8fNr9bNA=="; \ 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/AbstractNavigator.html b/docs/classes/AbstractNavigator.html index 12916507..6445957c 100644 --- a/docs/classes/AbstractNavigator.html +++ b/docs/classes/AbstractNavigator.html @@ -1,557 +1,89 @@ - - - - - - AbstractNavigator | @auth0/auth0-angular - - - - - - - - - - - - -
-
- @auth0/auth0-angular - - - - -
    -
    -
    Preparing search index...
    -
    -
    - -
    -
    -
    -
    -
    - -

    Class AbstractNavigator

    -
    - -
    -
    -
    - - -
    Index
    -
    -
    -
    -

    Constructors

    - -
    -
    -

    Methods

    - -
    -
    -
    -
    -
    -
    - - -

    Constructors

    -
    -
    -
    - - -
    -
    -
    -
    - - -

    Methods

    -
    -
    -
    - -
      -
    • - -
      -
      -

      - Navigates to the specified url. The router will be used - if one is available, otherwise it falls back to - window.history.replaceState. -

      -
      -
      -

      Parameters

      -
        -
      • - url: - string -
        -

        The url to navigate to

        -
        -
      • -
      -
      -

      - Returns void -

      - -
      -
    • -
    -
    -
    -
    -
    -
    - - -
    -
    -
    -
    - - +AbstractNavigator | @auth0/auth0-angular
    +
    @auth0/auth0-angular + +
      +
      +
      Preparing search index...
      +
      +
      +
      + +

      Class AbstractNavigator

      +
      +
      +
      +
      Index
      +
      +
      + +
      +
      + +
      +
      + +
      +
      + +
      +
      + +
      +
      + +
        +
      • + +
        +

        Navigates to the specified url. The router will be used if one is available, otherwise it falls back +to window.history.replaceState.

        +
        +
        +

        Parameters

        +
          +
        • url: string +

          The url to navigate to

          +
        +

        Returns void

      +
      + +
      +
      diff --git a/docs/classes/Auth0ClientFactory.html b/docs/classes/Auth0ClientFactory.html index 29784dad..17785a6c 100644 --- a/docs/classes/Auth0ClientFactory.html +++ b/docs/classes/Auth0ClientFactory.html @@ -1,518 +1,77 @@ - - - - - - Auth0ClientFactory | @auth0/auth0-angular - - - - - - - - - - - - -
      -
      - @auth0/auth0-angular - - - - -
        -
        -
        Preparing search index...
        -
        -
        - -
        -
        -
        -
        -
        - -

        Class Auth0ClientFactory

        -
        - -
        -
        -
        - - -
        Index
        -
        -
        -
        -

        Constructors

        - -
        -
        -

        Methods

        - -
        -
        -
        -
        -
        -
        - - -

        Constructors

        -
        -
        -
        - - -
        -
        -
        -
        - - -

        Methods

        -
        -
        -
        - - -
        -
        -
        -
        -
        - - -
        -
        -
        -
        - - +Auth0ClientFactory | @auth0/auth0-angular
        +
        @auth0/auth0-angular + +
          +
          +
          Preparing search index...
          +
          +
          +
          + +

          Class Auth0ClientFactory

          +
          +
          +
          +
          Index
          +
          +
          + +
          +
          + +
          +
          + +
          +
          + +
          +
          + +
          +
          + +
          +
          + +
          +
          diff --git a/docs/classes/AuthClientConfig.html b/docs/classes/AuthClientConfig.html index c03c773e..2e3d938d 100644 --- a/docs/classes/AuthClientConfig.html +++ b/docs/classes/AuthClientConfig.html @@ -1,649 +1,110 @@ - - - - - - AuthClientConfig | @auth0/auth0-angular - - - - - - - - - - - - -
          -
          - @auth0/auth0-angular - - - - -
            -
            -
            Preparing search index...
            -
            -
            - -
            -
            -
            -
            -
            - -

            Class AuthClientConfig

            -
            -
            -
            -

            - Gets and sets configuration for the internal Auth0 client. This - can be used to provide configuration outside of using - AuthModule.forRoot, i.e. from a factory provided by - APP_INITIALIZER. -

            -
            -
            -
            - -
            // app.module.ts
            // ---------------------------
            import { AuthModule, AuthClientConfig } from '@auth0/auth0-angular';

            // Provide an initializer function that returns a Promise
            function configInitializer(
            http: HttpClient,
            config: AuthClientConfig
            ) {
            return () =>
            http
            .get('/config')
            .toPromise()
            .then((loadedConfig: any) => config.set(loadedConfig)); // Set the config that was loaded asynchronously here
            }

            // Provide APP_INITIALIZER with this function. Note that there is no config passed to AuthModule.forRoot
            imports: [
            // other imports..

            HttpClientModule,
            AuthModule.forRoot(), //<- don't pass any config here
            ],
            providers: [
            {
            provide: APP_INITIALIZER,
            useFactory: configInitializer, // <- pass your initializer function here
            deps: [HttpClient, AuthClientConfig],
            multi: true,
            },
            ], +AuthClientConfig | @auth0/auth0-angular
            +
            @auth0/auth0-angular + +
              +
              +
              Preparing search index...
              +
              +
              +
              + +

              Class AuthClientConfig

              +
              +

              Gets and sets configuration for the internal Auth0 client. This can be +used to provide configuration outside of using AuthModule.forRoot, i.e. from +a factory provided by APP_INITIALIZER.

              +
              +
              +
              +
              // app.module.ts
              // ---------------------------
              import { AuthModule, AuthClientConfig } from '@auth0/auth0-angular';

              // Provide an initializer function that returns a Promise
              function configInitializer(
              http: HttpClient,
              config: AuthClientConfig
              ) {
              return () =>
              http
              .get('/config')
              .toPromise()
              .then((loadedConfig: any) => config.set(loadedConfig)); // Set the config that was loaded asynchronously here
              }

              // Provide APP_INITIALIZER with this function. Note that there is no config passed to AuthModule.forRoot
              imports: [
              // other imports..

              HttpClientModule,
              AuthModule.forRoot(), //<- don't pass any config here
              ],
              providers: [
              {
              provide: APP_INITIALIZER,
              useFactory: configInitializer, // <- pass your initializer function here
              deps: [HttpClient, AuthClientConfig],
              multi: true,
              },
              ],
              -
              -
              -
              - -
              -
              -
              - - -
              Index
              -
              -
              -
              -

              Constructors

              - -
              -
              -

              Methods

              - -
              -
              -
              -
              -
              -
              - - -

              Constructors

              -
              -
              -
              - - -
              -
              -
              -
              - - -

              Methods

              -
              -
              -
              - - -
              -
              - - -
              -
              -
              -
              -
              - - -
              -
              -
              -
              - - + +
              +
              +
              +
              +
              Index
              +
              +
              + +
              +
              + +
              get +set +
              +
              + +
              +
              + +
              +
              + +
              +
              + +
              +
              + +
              +
              + +
              +
              diff --git a/docs/classes/AuthGuard.html b/docs/classes/AuthGuard.html index 91f1351c..4568fb8d 100644 --- a/docs/classes/AuthGuard.html +++ b/docs/classes/AuthGuard.html @@ -1,761 +1,114 @@ - - - - - - AuthGuard | @auth0/auth0-angular - - - - - - - - - - - - -
              -
              - @auth0/auth0-angular - - - - -
                -
                -
                Preparing search index...
                -
                -
                - -
                -
                -
                -
                -
                - -

                Class AuthGuard

                -
                - -
                -
                -
                - - -
                Index
                -
                -
                -
                -

                Constructors

                - -
                -
                -

                Methods

                - -
                -
                -
                -
                -
                -
                - - -

                Constructors

                -
                -
                -
                - - -
                -
                -
                -
                - - -

                Methods

                -
                -
                -
                - -
                  -
                • - -
                  -
                  -

                  Parameters

                  -
                    -
                  • - next: - ActivatedRouteSnapshot -
                  • -
                  • - state: - RouterStateSnapshot -
                  • -
                  -
                  -

                  - Returns Observable<boolean> -

                  - -
                  -
                • -
                -
                -
                - -
                  -
                • - -
                  -
                  -

                  Parameters

                  -
                    -
                  • - childRoute: - ActivatedRouteSnapshot -
                  • -
                  • - state: - RouterStateSnapshot -
                  • -
                  -
                  -

                  - Returns Observable<boolean> -

                  - -
                  -
                • -
                -
                -
                - -
                  -
                • - -
                  -
                  -

                  Parameters

                  -
                    -
                  • - route: - Route -
                  • -
                  • - segments: - UrlSegment[] -
                  • -
                  -
                  -

                  - Returns Observable<boolean> -

                  - -
                  -
                • -
                -
                -
                -
                -
                -
                - - -
                -
                -
                -
                - - +AuthGuard | @auth0/auth0-angular
                +
                @auth0/auth0-angular + +
                  +
                  +
                  Preparing search index...
                  +
                  +
                  +
                  + +

                  Class AuthGuard

                  +
                  +
                  +
                  +
                  Index
                  +
                  +
                  + +
                  +
                  + +
                  +
                  + +
                  +
                  + +
                  +
                  + +
                  +
                  + +
                    +
                  • + +
                    +
                    +

                    Parameters

                    +
                      +
                    • next: ActivatedRouteSnapshot
                    • +
                    • state: RouterStateSnapshot
                    +

                    Returns Observable<boolean>

                  +
                  + +
                    +
                  • + +
                    +
                    +

                    Parameters

                    +
                      +
                    • childRoute: ActivatedRouteSnapshot
                    • +
                    • state: RouterStateSnapshot
                    +

                    Returns Observable<boolean>

                  +
                  + +
                  +
                  + +
                  +
                  diff --git a/docs/classes/AuthHttpInterceptor.html b/docs/classes/AuthHttpInterceptor.html index 65d6edfa..8b7869af 100644 --- a/docs/classes/AuthHttpInterceptor.html +++ b/docs/classes/AuthHttpInterceptor.html @@ -1,645 +1,100 @@ - - - - - - AuthHttpInterceptor | @auth0/auth0-angular - - - - - - - - - - - - -
                  -
                  - @auth0/auth0-angular - - - - -
                    -
                    -
                    Preparing search index...
                    -
                    -
                    - -
                    -
                    -
                    -
                    -
                    - -

                    Class AuthHttpInterceptor

                    -
                    -
                    -

                    Implements

                    -
                      -
                    • HttpInterceptor
                    • -
                    -
                    - -
                    -
                    -
                    - - -
                    Index
                    -
                    -
                    -
                    -

                    Constructors

                    - -
                    -
                    -

                    Methods

                    - -
                    -
                    -
                    -
                    -
                    -
                    - - -

                    Constructors

                    -
                    -
                    -
                    - - -
                    -
                    -
                    -
                    - - -

                    Methods

                    -
                    -
                    -
                    - -
                      -
                    • - -
                      -
                      -

                      Identifies and handles a given HTTP request.

                      -
                      -
                      -

                      Parameters

                      -
                        -
                      • - req: - HttpRequest<any> -
                        -

                        The outgoing request object to handle.

                        -
                        -
                      • -
                      • - next: - HttpHandler -
                        -

                        - The next interceptor in the chain, or the backend - if no interceptors remain in the chain. -

                        -
                        -
                      • -
                      -
                      -

                      - Returns Observable<HttpEvent<any>> -

                      -

                      An observable of the event stream.

                      - -
                      -
                    • -
                    -
                    -
                    -
                    -
                    -
                    - - -
                    -
                    -
                    -
                    - - +AuthHttpInterceptor | @auth0/auth0-angular
                    +
                    @auth0/auth0-angular + +
                      +
                      +
                      Preparing search index...
                      +
                      +
                      +
                      + +

                      Class AuthHttpInterceptor

                      +
                      +

                      Implements

                      +
                        +
                      • HttpInterceptor
                      +
                      +
                      +
                      +
                      Index
                      +
                      +
                      + +
                      +
                      + +
                      +
                      + +
                      +
                      + +
                      +
                      + +
                      +
                      + +
                        +
                      • + +
                        +

                        Identifies and handles a given HTTP request.

                        +
                        +
                        +

                        Parameters

                        +
                          +
                        • req: HttpRequest<any> +

                          The outgoing request object to handle.

                          +
                        • +
                        • next: HttpHandler +

                          The next interceptor in the chain, or the backend +if no interceptors remain in the chain.

                          +
                        +

                        Returns Observable<HttpEvent<any>>

                        An observable of the event stream.

                        +
                      +
                      + +
                      +
                      diff --git a/docs/classes/AuthModule.html b/docs/classes/AuthModule.html index e6401543..adb0b64b 100644 --- a/docs/classes/AuthModule.html +++ b/docs/classes/AuthModule.html @@ -1,532 +1,82 @@ - - - - - - AuthModule | @auth0/auth0-angular - - - - - - - - - - - - -
                      -
                      - @auth0/auth0-angular - - - - -
                        -
                        -
                        Preparing search index...
                        -
                        -
                        - -
                        -
                        -
                        -
                        -
                        - -

                        Class AuthModule

                        -
                        - -
                        -
                        -
                        - - -
                        Index
                        -
                        -
                        -
                        -

                        Constructors

                        - -
                        -
                        -

                        Methods

                        - -
                        -
                        -
                        -
                        -
                        -
                        - - -

                        Constructors

                        -
                        -
                        -
                        - - -
                        -
                        -
                        -
                        - - -

                        Methods

                        -
                        -
                        -
                        - -
                          -
                        • - -
                          -
                          -

                          - Initialize the authentication module system. - Configuration can either be specified here, or by - calling AuthClientConfig.set (perhaps from an - APP_INITIALIZER factory function). -

                          -
                          -
                          -

                          Parameters

                          -
                            -
                          • - Optionalconfig: - AuthConfig -
                            -

                            The optional configuration for the SDK.

                            -
                            -
                          • -
                          -
                          -

                          - Returns - ModuleWithProviders<AuthModule> -

                          - -
                          -
                        • -
                        -
                        -
                        -
                        -
                        -
                        - - -
                        -
                        -
                        -
                        - - +AuthModule | @auth0/auth0-angular
                        +
                        @auth0/auth0-angular + +
                          +
                          +
                          Preparing search index...
                          +
                          +
                          +
                          + +

                          Class AuthModule

                          +
                          +
                          +
                          +
                          Index
                          +
                          +
                          + +
                          +
                          + +
                          +
                          + +
                          +
                          + +
                          +
                          + +
                          +
                          + +
                          +
                          + +
                          +
                          diff --git a/docs/classes/AuthService.html b/docs/classes/AuthService.html index 17c91594..d3e0bc27 100644 --- a/docs/classes/AuthService.html +++ b/docs/classes/AuthService.html @@ -1,2969 +1,525 @@ - - - - - - AuthService | @auth0/auth0-angular - - - - - - - - - - - - -
                          -
                          - @auth0/auth0-angular - - - - -
                            -
                            -
                            Preparing search index...
                            -
                            -
                            - -
                            -
                            -
                            -
                            -
                            - -

                            Class AuthService<TAppState>

                            -
                            -
                            -

                            Type Parameters

                            - -
                            -
                            -

                            Implements

                            -
                              -
                            • OnDestroy
                            • -
                            -
                            - -
                            -
                            -
                            - - -
                            Index
                            -
                            - -
                            -
                            -
                            -
                            - - -

                            Constructors

                            -
                            -
                            -
                            - - -
                            -
                            -
                            -
                            - - -

                            Properties

                            -
                            -
                            -
                            - -
                            - appState$: - Observable<TAppState> = ... -
                            -
                            -

                            - Emits the value (if any) that was passed to the - loginWithRedirect method call but only - after handleRedirectCallback is - first called -

                            -
                            - -
                            -
                            - -
                            - error$: - Observable<Error> = ... -
                            -
                            -

                            - Emits errors that occur during login, or when checking for an - active session on startup. -

                            -
                            - -
                            -
                            - -
                            - idTokenClaims$: - Observable<IdToken - | - null - | - undefined> = ... -
                            -
                            -

                            - Emits ID token claims when authenticated, or null if not - authenticated. -

                            -
                            - -
                            -
                            - -
                            - isAuthenticated$: - Observable<boolean> = ... -
                            -
                            -

                            - Emits boolean values indicating the authentication state of - the user. If true, it means a user has - authenticated. This depends on the value of - isLoading$, so there is no need to manually check - the loading state of the SDK. -

                            -
                            - -
                            -
                            - -
                            - isLoading$: - Observable<boolean> = ... -
                            -
                            -

                            - Emits boolean values indicating the loading state of the SDK. -

                            -
                            - -
                            -
                            - -
                            - mfa: - ObservableMfaApiClient = ... -
                            -
                            -

                            - Provides MFA (Multi-Factor Authentication) operations as - Observables. -

                            -

                            - These methods are available after - getAccessTokenSilently throws an - MfaRequiredError. Use the - mfa_token from the error to call these methods. -

                            -
                            - -
                            -
                            - -
                            - myAccount: - ObservableMyAccountApiClient = ... -
                            -
                            -

                            Provides MyAccount API operations as Observables.

                            -

                            - Allows the authenticated user to list, enroll, update, and - delete their authentication methods. Requires an access token - with the appropriate - read/create/update/delete:me:authentication-methods - scopes. -

                            -
                            - -
                            -
                            - -
                            - passkey: - ObservablePasskeyApiClient = ... -
                            -
                            -

                            - Provides Passkey (WebAuthn) authentication as Observables. -

                            -

                            - Both methods handle the full WebAuthn challenge-response flow - internally. After a successful call, this updates the - authentication state to ensure consistency with the standard - authentication flows. -

                            -
                            - -
                            -
                            - -
                            - user$: - Observable<User - | - null - | - undefined> = ... -
                            -
                            -

                            - Emits details about the authenticated user, or null if not - authenticated. -

                            -
                            - -
                            -
                            -
                            -
                            - - -

                            Methods

                            -
                            -
                            -
                            - -
                              -
                            • - -
                              -
                              -
                              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
                              }
                              }); +AuthService | @auth0/auth0-angular
                              +
                              @auth0/auth0-angular + +
                                +
                                +
                                Preparing search index...
                                +
                                +
                                +
                                + +

                                Class AuthService<TAppState>

                                +
                                +

                                Type Parameters

                                +
                                +
                                +

                                Implements

                                +
                                  +
                                • OnDestroy
                                +
                                +
                                +
                                +
                                Index
                                +
                                +
                                + +
                                +
                                + +
                                +
                                + +
                                +
                                + +
                                appState$: Observable<TAppState> = ...
                                +

                                Emits the value (if any) that was passed to the loginWithRedirect method call +but only after handleRedirectCallback is first called

                                +
                                +
                                + +
                                error$: Observable<Error> = ...
                                +

                                Emits errors that occur during login, or when checking for an active session on startup.

                                +
                                +
                                + +
                                idTokenClaims$: Observable<IdToken | null | undefined> = ...
                                +

                                Emits ID token claims when authenticated, or null if not authenticated.

                                +
                                +
                                + +
                                isAuthenticated$: Observable<boolean> = ...
                                +

                                Emits boolean values indicating the authentication state of the user. If true, it means a user has authenticated. +This depends on the value of isLoading$, so there is no need to manually check the loading state of the SDK.

                                +
                                +
                                + +
                                isLoading$: Observable<boolean> = ...
                                +

                                Emits boolean values indicating the loading state of the SDK.

                                +
                                +
                                + + +

                                Provides MFA (Multi-Factor Authentication) operations as Observables.

                                +

                                These methods are available after getAccessTokenSilently throws an MfaRequiredError. +Use the mfa_token from the error to call these methods.

                                +
                                +
                                + + +

                                Provides MyAccount API operations as Observables.

                                +

                                Allows the authenticated user to list, enroll, update, and delete their +authentication methods. Requires an access token with the appropriate +read/create/update/delete:me:authentication-methods scopes.

                                +
                                +
                                + + +

                                Provides Passkey (WebAuthn) authentication as Observables.

                                +

                                Both methods handle the full WebAuthn challenge-response flow internally. +After a successful call, this updates the authentication state to ensure +consistency with the standard authentication flows.

                                +
                                +
                                + +
                                user$: Observable<User | null | undefined> = ...
                                +

                                Emits details about the authenticated user, or null if not authenticated.

                                +
                                +
                                + +
                                +
                                + +
                                  +
                                • + +
                                  +
                                  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 provided as arguments. This then redirects to - the connection's login page where the user can - authenticate and authorize the account to be connected. -

                                  -

                                  - If connecting the account is successful, - handleRedirectCallback will be called with - the details of the connected account. -

                                  -
                                  -
                                  -

                                  Parameters

                                  - -
                                  -

                                  - Returns Observable<void> -

                                  - -
                                  -
                                • -
                                -
                                -
                                - -
                                +
                                + + -
                                -
                                - -
                                  -
                                • - -
                                  -
                                  -
                                  generateDpopProof(params).subscribe(proof => ...)
                                  +

                                  Creates a custom fetcher instance that can be used to make authenticated +HTTP requests. The fetcher automatically handles token refresh and can +be configured with custom request/response handling.

                                  +
                                  +
                                  +

                                  Type Parameters

                                  +
                                  +
                                  +

                                  Parameters

                                  +
                                  +

                                  Returns Fetcher<TOutput>

                                  A Fetcher instance configured with the Auth0 client.

                                  +
                                +
                                + +
                                  +
                                • + +
                                  +
                                  generateDpopProof(params).subscribe(proof => ...)
                                   
                                  -

                                  - Generates a DPoP (Demonstrating Proof-of-Possession) - proof JWT. This proof is used to bind access tokens to a - specific client, providing an additional layer of - security for token usage. -

                                  -
                                  -
                                  -

                                  Parameters

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

                                    Configuration for generating the DPoP proof

                                    -
                                    -
                                      -
                                    • -
                                      - accessToken: string -
                                      -
                                      -

                                      The access token to bind to the proof

                                      -
                                      -
                                    • -
                                    • -
                                      - method: string -
                                      -
                                      -

                                      The HTTP method (e.g., 'GET', 'POST')

                                      -
                                      -
                                    • -
                                    • -
                                      - Optionalnonce?: string -
                                      -
                                      -

                                      - Optional DPoP nonce from the authorization - server -

                                      -
                                      -
                                    • -
                                    • -
                                      - url: string -
                                      -
                                      -

                                      The URL of the resource server endpoint

                                      -
                                      -
                                    • -
                                    -
                                  • -
                                  -
                                  -

                                  - Returns Observable<string> -

                                  -

                                  - An Observable that emits the generated DPoP proof as a JWT - string. -

                                  - -
                                  -
                                • -
                                -
                                -
                                - - -
                                -
                                - -
                                  -
                                • - -
                                  -
                                  -
                                  getTokenWithPopup(options).subscribe(token => ...)
                                  +

                                  Generates a DPoP (Demonstrating Proof-of-Possession) proof JWT. +This proof is used to bind access tokens to a specific client, providing +an additional layer of security for token usage.

                                  +
                                  +
                                  +

                                  Parameters

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

                                    Configuration for generating the DPoP proof

                                    +
                                    +
                                      +
                                    • +
                                      accessToken: string
                                      +

                                      The access token to bind to the proof

                                      +
                                    • +
                                    • +
                                      method: string
                                      +

                                      The HTTP method (e.g., 'GET', 'POST')

                                      +
                                    • +
                                    • +
                                      Optionalnonce?: string
                                      +

                                      Optional DPoP nonce from the authorization server

                                      +
                                    • +
                                    • +
                                      url: string
                                      +

                                      The URL of the resource server endpoint

                                      +
                                  +

                                  Returns Observable<string>

                                  An Observable that emits the generated DPoP proof as a JWT string.

                                  +
                                +
                                + +
                                +
                                + +
                                  +
                                • + +
                                  +
                                  getTokenWithPopup(options).subscribe(token => ...)
                                   
                                  -

                                  Get an access token interactively.

                                  -

                                  - Opens a popup with the /authorize URL using - the parameters 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. -

                                  -
                                  -
                                  -

                                  Parameters

                                  - -
                                  -

                                  - Returns Observable<string - | - undefined> -

                                  - -
                                  -
                                • -
                                -
                                -
                                - -
                                  -
                                • - -
                                  -
                                  -
                                  getDpopNonce(id).subscribe(nonce => ...)
                                  +

                                  Get an access token interactively.

                                  +

                                  Opens a popup with the /authorize URL using the parameters +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.

                                  +
                                  +
                                  +

                                  Parameters

                                  +
                                  +

                                  Returns Observable<string | undefined>

                                +
                                + +
                                  +
                                • + +
                                  +
                                  getDpopNonce(id).subscribe(nonce => ...)
                                   
                                  -

                                  - Gets the DPoP nonce for the specified domain or the - default domain. The nonce is used in DPoP proof - generation for token binding. -

                                  -
                                  -
                                  -

                                  Parameters

                                  -
                                    -
                                  • - Optionalid: - string -
                                    -

                                    - Optional identifier for the domain. If not - provided, uses the default domain. -

                                    -
                                    -
                                  • -
                                  -
                                  -

                                  - Returns Observable<string - | - undefined> -

                                  -

                                  - An Observable that emits the DPoP nonce string or - undefined if not available. -

                                  - -
                                  -
                                • -
                                -
                                -
                                - -
                                  -
                                • - -
                                  -
                                  -
                                  handleRedirectCallback(url).subscribe(result => ...)
                                  +

                                  Gets the DPoP nonce for the specified domain or the default domain. +The nonce is used in DPoP proof generation for token binding.

                                  +
                                  +
                                  +

                                  Parameters

                                  +
                                    +
                                  • Optionalid: string +

                                    Optional identifier for the domain. If not provided, uses the default domain.

                                    +
                                  +

                                  Returns Observable<string | undefined>

                                  An Observable that emits the DPoP nonce string or undefined if not available.

                                  +
                                +
                                + +
                                  +
                                • + +
                                  +
                                  handleRedirectCallback(url).subscribe(result => ...)
                                   
                                  -

                                  - 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. -

                                  -

                                  - Calling this method also refreshes the authentication - and user states. -

                                  -
                                  -
                                  -

                                  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 Observable<
                                      RedirectLoginResult<TAppState>
                                      | - ConnectAccountRedirectResult<TAppState>,
                                  > -

                                  - -
                                  -
                                • -
                                -
                                -
                                - -
                                  -
                                • - -
                                  -
                                  -
                                  loginWithCustomTokenExchange(options).subscribe(tokenResponse => ...)
                                  +

                                  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.

                                  +

                                  Calling this method also refreshes the authentication and user states.

                                  +
                                  +
                                  +

                                  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 Observable<
                                      RedirectLoginResult<TAppState>
                                      | ConnectAccountRedirectResult<TAppState>,
                                  >

                                +
                                + +
                                  +
                                • + +
                                  +
                                  loginWithCustomTokenExchange(options).subscribe(tokenResponse => ...)
                                   
                                  -

                                  - Exchanges an external subject token for Auth0 tokens and - establishes an authenticated session. -

                                  -

                                  - This method implements the token exchange grant as - specified in RFC 8693. It performs a token exchange by - sending a request to the - /oauth/token endpoint with the external - token and returns Auth0 tokens (access token, ID token, - etc.). -

                                  -

                                  The request includes the following parameters:

                                  -
                                    -
                                  • - grant_type: Hard-coded to - "urn:ietf:params:oauth:grant-type:token-exchange" -
                                  • -
                                  • - subject_token: The external token to be - exchanged -
                                  • -
                                  • - subject_token_type: A namespaced URI - identifying the token type (must be under your - organization's control) -
                                  • -
                                  • - audience: The target audience (falls back - to the SDK's default audience if not provided) -
                                  • -
                                  • - scope: Space-separated list of scopes - (merged with the SDK's default scopes) -
                                  • -
                                  -

                                  - After a successful token exchange, this method updates - the authentication state to ensure consistency with the - standard authentication flows. -

                                  -
                                  -
                                  -

                                  Parameters

                                  - -
                                  -

                                  - Returns Observable<TokenEndpointResponse> -

                                  -

                                  - An Observable that emits the token endpoint response - containing Auth0 tokens -

                                  - -
                                  -
                                • -
                                -
                                -
                                - -
                                  -
                                • - -
                                  -
                                  -
                                  await loginWithPopup(options);
                                  +

                                  Exchanges an external subject token for Auth0 tokens and establishes an authenticated session.

                                  +

                                  This method implements the token exchange grant as specified in RFC 8693. +It performs a token exchange by sending a request to the /oauth/token endpoint +with the external token and returns Auth0 tokens (access token, ID token, etc.).

                                  +

                                  The request includes the following parameters:

                                  +
                                    +
                                  • grant_type: Hard-coded to "urn:ietf:params:oauth:grant-type:token-exchange"
                                  • +
                                  • subject_token: The external token to be exchanged
                                  • +
                                  • subject_token_type: A namespaced URI identifying the token type (must be under your organization's control)
                                  • +
                                  • audience: The target audience (falls back to the SDK's default audience if not provided)
                                  • +
                                  • scope: Space-separated list of scopes (merged with the SDK's default scopes)
                                  • +
                                  +

                                  After a successful token exchange, this method updates the authentication state +to ensure consistency with the standard authentication flows.

                                  +
                                  +
                                  +

                                  Parameters

                                  +
                                  +

                                  Returns Observable<TokenEndpointResponse>

                                  An Observable that emits the token endpoint response containing Auth0 tokens

                                  +
                                +
                                + +
                                  +
                                • + +
                                  +
                                  await loginWithPopup(options);
                                   
                                  -

                                  - Opens a popup with the /authorize URL using - the parameters 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. -

                                  -

                                  - 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. -

                                  -
                                  -
                                  -

                                  Parameters

                                  - -
                                  -

                                  - Returns Observable<void> -

                                  - -
                                  -
                                • -
                                -
                                -
                                - -
                                  -
                                • - -
                                  -
                                  -
                                  loginWithRedirect(options);
                                  +

                                  Opens a popup with the /authorize URL using the parameters +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.

                                  +

                                  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.

                                  +
                                  +
                                  +

                                  Parameters

                                  +
                                  +

                                  Returns Observable<void>

                                +
                                + + -
                                -
                                - -
                                +
                                + +
                                  +
                                • + +
                                  +
                                  logout();
                                   
                                  -

                                  - Clears the application session and performs a redirect - to /v2/logout, using the parameters - provided as arguments, to clear the Auth0 session. If - the federated option is specified it also - clears the Identity Provider session. If the - openUrl option is set to false, it only - clears the application session. It is invalid to set - both the federated to true and - openUrl to false, and an error - will be thrown if you do. - Read more about how Logout works at Auth0. -

                                  -
                                  -
                                  -

                                  Parameters

                                  -
                                    -
                                  • - Optionaloptions: - LogoutOptions -
                                    -

                                    The logout options

                                    -
                                    -
                                  • -
                                  -
                                  -

                                  - Returns Observable<void> -

                                  - -
                                  -
                                • -
                                -
                                -
                                - - -
                                -
                                - -
                                  -
                                • - -
                                  -
                                  -
                                  setDpopNonce(nonce, id).subscribe(() => ...)
                                  +

                                  Clears the application session and performs a redirect to /v2/logout, using +the parameters provided as arguments, to clear the Auth0 session. +If the federated option is specified it also clears the Identity Provider session. +If the openUrl option is set to false, it only clears the application session. +It is invalid to set both the federated to true and openUrl to false, +and an error will be thrown if you do. +Read more about how Logout works at Auth0.

                                  +
                                  +
                                  +

                                  Parameters

                                  +
                                  +

                                  Returns Observable<void>

                                +
                                + +
                                +
                                + +
                                  +
                                • + +
                                  +
                                  setDpopNonce(nonce, id).subscribe(() => ...)
                                   
                                  -

                                  - Sets the DPoP nonce for the specified domain or the - default domain. This is typically used after receiving a - new nonce from the authorization server. -

                                  -
                                  -
                                  -

                                  Parameters

                                  -
                                    -
                                  • - nonce: - string -
                                    -

                                    The DPoP nonce value to set.

                                    -
                                    -
                                  • -
                                  • - Optionalid: - string -
                                    -

                                    - Optional identifier for the domain. If not - provided, uses the default domain. -

                                    -
                                    -
                                  • -
                                  -
                                  -

                                  - Returns Observable<void> -

                                  -

                                  An Observable that completes when the nonce is set.

                                  - -
                                  -
                                • -
                                -
                                -
                                -
                                -
                                -
                                - - -
                                -
                                -
                                -
                                - - +

                                Sets the DPoP nonce for the specified domain or the default domain. +This is typically used after receiving a new nonce from the authorization server.

                                +
                                +
                                +

                                Parameters

                                +
                                  +
                                • nonce: string +

                                  The DPoP nonce value to set.

                                  +
                                • +
                                • Optionalid: string +

                                  Optional identifier for the domain. If not provided, uses the default domain.

                                  +
                                +

                                Returns Observable<void>

                                An Observable that completes when the nonce is set.

                                +
                              +
                              +
                              diff --git a/docs/classes/AuthState.html b/docs/classes/AuthState.html index 590b7a53..f87b13e8 100644 --- a/docs/classes/AuthState.html +++ b/docs/classes/AuthState.html @@ -1,1121 +1,188 @@ - - - - - - AuthState | @auth0/auth0-angular - - - - - - - - - - - - -
                              -
                              - @auth0/auth0-angular - - - - -
                                -
                                -
                                Preparing search index...
                                -
                                -
                                - -
                                -
                                -
                                -
                                -
                                - -

                                Class AuthState

                                -
                                -
                                -
                                -

                                Tracks the Authentication State for the SDK

                                -
                                -
                                - -
                                -
                                -
                                - - -
                                Index
                                -
                                - -
                                -
                                -
                                -
                                - - -

                                Constructors

                                -
                                -
                                -
                                - - -
                                -
                                -
                                -
                                - - -

                                Properties

                                -
                                -
                                -
                                - -
                                - error$: - Observable<Error> = ... -
                                -
                                -

                                - Emits errors that occur during login, or when checking for an - active session on startup. -

                                -
                                - -
                                -
                                - -
                                - idTokenClaims$: - Observable<IdToken - | - null - | - undefined> = ... -
                                -
                                -

                                - Emits ID token claims when authenticated, or null if not - authenticated. -

                                -
                                - -
                                -
                                - -
                                - isAuthenticated$: - Observable<boolean> = ... -
                                -
                                -

                                - Emits boolean values indicating the authentication state of - the user. If true, it means a user has - authenticated. This depends on the value of - isLoading$, so there is no need to manually check - the loading state of the SDK. -

                                -
                                - -
                                -
                                - -
                                - isLoading$: - Observable<boolean> = ... -
                                -
                                -

                                - Emits boolean values indicating the loading state of the SDK. -

                                -
                                - -
                                -
                                - -
                                - user$: - Observable<User - | - null - | - undefined> = ... -
                                -
                                -

                                - Emits details about the authenticated user, or null if not - authenticated. -

                                -
                                - -
                                -
                                -
                                -
                                - - -

                                Methods

                                -
                                -
                                -
                                - -
                                  -
                                • - -
                                  -
                                  -

                                  - Refresh the state to ensure the - isAuthenticated, user$ and - idTokenClaims$ reflect the most up-to-date - values from Auth0Client. -

                                  -
                                  -

                                  - Returns void -

                                  - -
                                  -
                                • -
                                -
                                -
                                - -
                                  -
                                • - -
                                  -
                                  -

                                  - Update the access token, doing so will also refresh the - state. -

                                  -
                                  -
                                  -

                                  Parameters

                                  -
                                    -
                                  • - accessToken: - string -
                                    -

                                    The new Access Token

                                    -
                                    -
                                  • -
                                  -
                                  -

                                  - Returns void -

                                  - -
                                  -
                                • -
                                -
                                -
                                - -
                                  -
                                • - -
                                  -
                                  -

                                  - Emits the error in the error$ observable. -

                                  -
                                  -
                                  -

                                  Parameters

                                  -
                                    -
                                  • - error: - any -
                                    -

                                    The new error

                                    -
                                    -
                                  • -
                                  -
                                  -

                                  - Returns void -

                                  - -
                                  -
                                • -
                                -
                                -
                                - -
                                  -
                                • - -
                                  -
                                  -

                                  Update the isLoading state using the provided value

                                  -
                                  -
                                  -

                                  Parameters

                                  -
                                    -
                                  • - isLoading: - boolean -
                                    -

                                    The new value for isLoading

                                    -
                                    -
                                  • -
                                  -
                                  -

                                  - Returns void -

                                  - -
                                  -
                                • -
                                -
                                -
                                -
                                -
                                -
                                - - -
                                -
                                -
                                -
                                - - +AuthState | @auth0/auth0-angular
                                +
                                @auth0/auth0-angular + +
                                  +
                                  +
                                  Preparing search index...
                                  +
                                  +
                                  +
                                  + +

                                  Class AuthState

                                  +
                                  +

                                  Tracks the Authentication State for the SDK

                                  +
                                  +
                                  +
                                  +
                                  +
                                  Index
                                  +
                                  +
                                  + +
                                  +
                                  + +
                                  +
                                  + +
                                  +
                                  + +
                                  error$: Observable<Error> = ...
                                  +

                                  Emits errors that occur during login, or when checking for an active session on startup.

                                  +
                                  +
                                  + +
                                  idTokenClaims$: Observable<IdToken | null | undefined> = ...
                                  +

                                  Emits ID token claims when authenticated, or null if not authenticated.

                                  +
                                  +
                                  + +
                                  isAuthenticated$: Observable<boolean> = ...
                                  +

                                  Emits boolean values indicating the authentication state of the user. If true, it means a user has authenticated. +This depends on the value of isLoading$, so there is no need to manually check the loading state of the SDK.

                                  +
                                  +
                                  + +
                                  isLoading$: Observable<boolean> = ...
                                  +

                                  Emits boolean values indicating the loading state of the SDK.

                                  +
                                  +
                                  + +
                                  user$: Observable<User | null | undefined> = ...
                                  +

                                  Emits details about the authenticated user, or null if not authenticated.

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

                                    Update the access token, doing so will also refresh the state.

                                    +
                                    +
                                    +

                                    Parameters

                                    +
                                      +
                                    • accessToken: string +

                                      The new Access Token

                                      +
                                    +

                                    Returns void

                                  +
                                  + +
                                  +
                                  + +
                                    +
                                  • + +
                                    +

                                    Update the isLoading state using the provided value

                                    +
                                    +
                                    +

                                    Parameters

                                    +
                                      +
                                    • isLoading: boolean +

                                      The new value for isLoading

                                      +
                                    +

                                    Returns void

                                  +
                                  + +
                                  +
                                  diff --git a/docs/classes/AuthenticationError.html b/docs/classes/AuthenticationError.html index 133bb156..a24e09b8 100644 --- a/docs/classes/AuthenticationError.html +++ b/docs/classes/AuthenticationError.html @@ -1,1345 +1,221 @@ - - - - - - AuthenticationError | @auth0/auth0-angular - - - - - - - - - - - - -
                                  -
                                  - @auth0/auth0-angular - - - - -
                                    -
                                    -
                                    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

                                    -
                                    -
                                    -
                                    - -
                                      -
                                    • - -
                                      -
                                      -

                                      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 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 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` +AuthenticationError | @auth0/auth0-angular
                                      +
                                      @auth0/auth0-angular + +
                                        +
                                        +
                                        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
                                        +
                                        +
                                        + +
                                        +
                                        + +
                                          +
                                        • + +
                                          +
                                          +

                                          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.

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

                                          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`
                                          -

                                          - The first line of the trace will be prefixed with - ${myObject.name}: ${myObject.message}. -

                                          -

                                          - The optional constructorOpt argument - accepts a function. If given, all frames above - constructorOpt, including - constructorOpt, will be omitted from the - generated stack trace. -

                                          -

                                          - The constructorOpt argument is useful for - hiding implementation details of error generation from - the user. For instance: -

                                          -
                                          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(); +

                                          The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

                                          +

                                          The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

                                          +

                                          The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

                                          +
                                          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 -

                                          - -
                                          -
                                        • -
                                        -
                                        -
                                        - - -
                                        -
                                        -
                                        -
                                        -
                                        - - -
                                        -
                                        -
                                        -
                                        - - + +
                                        +
                                        +

                                        Parameters

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

                                        Returns void

                                      +
                                      + +
                                        +
                                      • + +
                                        +
                                        +

                                        Parameters

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

                                        Returns GenericError

                                      +
                                      + +
                                      +
                                      + +
                                      +
                                      diff --git a/docs/classes/ConnectError.html b/docs/classes/ConnectError.html index 2820f346..651fd3a7 100644 --- a/docs/classes/ConnectError.html +++ b/docs/classes/ConnectError.html @@ -1,1398 +1,228 @@ - - - - - - ConnectError | @auth0/auth0-angular - - - - - - - - - - - - -
                                      -
                                      - @auth0/auth0-angular - - - - -
                                        -
                                        -
                                        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

                                        -
                                        -
                                        -
                                        - -
                                          -
                                        • - -
                                          -
                                          -

                                          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 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 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` +ConnectError | @auth0/auth0-angular
                                          +
                                          @auth0/auth0-angular + +
                                            +
                                            +
                                            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
                                            +
                                            +
                                            + +
                                            +
                                            + +
                                              +
                                            • + +
                                              +
                                              +

                                              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.

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

                                              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`
                                              -

                                              - The first line of the trace will be prefixed with - ${myObject.name}: ${myObject.message}. -

                                              -

                                              - The optional constructorOpt argument - accepts a function. If given, all frames above - constructorOpt, including - constructorOpt, will be omitted from the - generated stack trace. -

                                              -

                                              - The constructorOpt argument is useful for - hiding implementation details of error generation from - the user. For instance: -

                                              -
                                              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(); +

                                              The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

                                              +

                                              The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

                                              +

                                              The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

                                              +
                                              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 -

                                              - -
                                              -
                                            • -
                                            -
                                            -
                                            - - -
                                            -
                                            -
                                            -
                                            -
                                            - - -
                                            -
                                            -
                                            -
                                            - - + +
                                            +
                                            +

                                            Parameters

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

                                            Returns void

                                          +
                                          + +
                                            +
                                          • + +
                                            +
                                            +

                                            Parameters

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

                                            Returns GenericError

                                          +
                                          + +
                                          +
                                          + +
                                          +
                                          diff --git a/docs/classes/Fetcher.html b/docs/classes/Fetcher.html index dd25edeb..0ad17e50 100644 --- a/docs/classes/Fetcher.html +++ b/docs/classes/Fetcher.html @@ -1,7 +1,38 @@ -Fetcher | @auth0/auth0-angular
                                          @auth0/auth0-angular
                                            Preparing search index...

                                            Class Fetcher<TOutput>

                                            Type Parameters

                                            Index

                                            Constructors

                                            Properties

                                            config +Fetcher | @auth0/auth0-angular
                                            +
                                            @auth0/auth0-angular + +
                                              +
                                              +
                                              Preparing search index...
                                              +
                                              +
                                              +
                                              + +

                                              Class Fetcher<TOutput>

                                              +
                                              +

                                              Type Parameters

                                              +
                                              +
                                              +
                                              +
                                              +
                                              Index
                                              +

                                              Constructors

                                              Properties

                                              config: Omit<FetcherConfig<TOutput>, "fetch"> & Required<
                                                  Pick<FetcherConfig<TOutput>, "fetch">,
                                              >
                                              hooks: FetcherHooks

                                              Methods

                                              • Parameters

                                                • info: RequestInfo | URL
                                                • init: RequestInit | undefined

                                                Returns Request

                                              • Parameters

                                                • baseUrl: string | undefined
                                                • url: string | undefined

                                                Returns string

                                              • Parameters

                                                • info: RequestInfo | URL

                                                Returns string

                                              • Parameters

                                                • info: RequestInfo | URL
                                                • Optionalinit: RequestInit
                                                • OptionalauthParams: AuthParams

                                                Returns Promise<TOutput>

                                              • Parameters

                                                • OptionalauthParams: AuthParams

                                                Returns Promise<string | GetTokenSilentlyVerboseResponse>

                                              • Parameters

                                                • headers: ResponseHeaders
                                                • name: string

                                                Returns string

                                              • Parameters

                                                Returns Promise<TOutput>

                                              • Parameters

                                                Returns boolean

                                              • Parameters

                                                • info: RequestInfo | URL
                                                • init: RequestInit | undefined
                                                • callbacks: FetchWithAuthCallbacks<TOutput>
                                                • OptionalauthParams: AuthParams

                                                Returns Promise<TOutput>

                                              • Parameters

                                                • url: string

                                                Returns boolean

                                              • Parameters

                                                • request: Request
                                                • OptionalauthParams: AuthParams

                                                Returns Promise<void>

                                              • Parameters

                                                • request: Request
                                                • accessToken: string
                                                • OptionaltokenType: string

                                                Returns void

                                              • Parameters

                                                • request: Request
                                                • accessToken: string

                                                Returns Promise<void>

                                              +
                                              +
                                              + +
                                              +
                                              + +
                                              +
                                              + +
                                              +
                                              + +
                                              config: Omit<FetcherConfig<TOutput>, "fetch"> & Required<
                                                  Pick<FetcherConfig<TOutput>, "fetch">,
                                              >
                                              +
                                              + +
                                              hooks: FetcherHooks
                                              +
                                              + +
                                              +
                                              + +
                                                +
                                              • + +
                                                +
                                                +

                                                Parameters

                                                +
                                                  +
                                                • info: RequestInfo | URL
                                                • +
                                                • init: RequestInit | undefined
                                                +

                                                Returns Request

                                              +
                                              + +
                                                +
                                              • + +
                                                +
                                                +

                                                Parameters

                                                +
                                                  +
                                                • baseUrl: string | undefined
                                                • +
                                                • url: string | undefined
                                                +

                                                Returns string

                                              +
                                              + +
                                                +
                                              • + +
                                                +
                                                +

                                                Parameters

                                                +
                                                  +
                                                • info: RequestInfo | URL
                                                +

                                                Returns string

                                              +
                                              + +
                                                +
                                              • + +
                                                +
                                                +

                                                Parameters

                                                +
                                                  +
                                                • info: RequestInfo | URL
                                                • +
                                                • Optionalinit: RequestInit
                                                • +
                                                • OptionalauthParams: AuthParams
                                                +

                                                Returns Promise<TOutput>

                                              +
                                              + +
                                                +
                                              • + +
                                                +
                                                +

                                                Parameters

                                                +
                                                  +
                                                • OptionalauthParams: AuthParams
                                                +

                                                Returns Promise<string | GetTokenSilentlyVerboseResponse>

                                              +
                                              + +
                                                +
                                              • + +
                                                +
                                                +

                                                Parameters

                                                +
                                                  +
                                                • headers: ResponseHeaders
                                                • +
                                                • name: string
                                                +

                                                Returns string

                                              +
                                              + +
                                                +
                                              • + +
                                                +
                                                +

                                                Parameters

                                                +
                                                +

                                                Returns Promise<TOutput>

                                              +
                                              + +
                                                +
                                              • + +
                                                +
                                                +

                                                Parameters

                                                +
                                                +

                                                Returns boolean

                                              +
                                              + +
                                                +
                                              • + +
                                                +
                                                +

                                                Parameters

                                                +
                                                  +
                                                • info: RequestInfo | URL
                                                • +
                                                • init: RequestInit | undefined
                                                • +
                                                • callbacks: FetchWithAuthCallbacks<TOutput>
                                                • +
                                                • OptionalauthParams: AuthParams
                                                +

                                                Returns Promise<TOutput>

                                              +
                                              + +
                                                +
                                              • + +
                                                +
                                                +

                                                Parameters

                                                +
                                                  +
                                                • url: string
                                                +

                                                Returns boolean

                                              +
                                              + +
                                                +
                                              • + +
                                                +
                                                +

                                                Parameters

                                                +
                                                  +
                                                • request: Request
                                                • +
                                                • OptionalauthParams: AuthParams
                                                +

                                                Returns Promise<void>

                                              +
                                              + +
                                                +
                                              • + +
                                                +
                                                +

                                                Parameters

                                                +
                                                  +
                                                • request: Request
                                                • +
                                                • accessToken: string
                                                • +
                                                • OptionaltokenType: string
                                                +

                                                Returns void

                                              +
                                              + +
                                                +
                                              • + +
                                                +
                                                +

                                                Parameters

                                                +
                                                  +
                                                • request: Request
                                                • +
                                                • accessToken: string
                                                +

                                                Returns Promise<void>

                                              +
                                              + +
                                              +
                                              diff --git a/docs/classes/GenericError.html b/docs/classes/GenericError.html index b2bdafec..3387b9c6 100644 --- a/docs/classes/GenericError.html +++ b/docs/classes/GenericError.html @@ -1,1217 +1,215 @@ - - - - - - GenericError | @auth0/auth0-angular - - - - - - - - - - - - -
                                              -
                                              - @auth0/auth0-angular - - - - -
                                                -
                                                -
                                                Preparing search index...
                                                -
                                                -
                                                - -
                                                -
                                                -
                                                -
                                                -
                                                - -

                                                Class GenericError

                                                -
                                                -
                                                -
                                                -

                                                Thrown when network requests to the Auth server fail.

                                                -
                                                -
                                                -
                                                -

                                                - Hierarchy (View Summary) -

                                                - -
                                                - -
                                                -
                                                -
                                                - - -
                                                Index
                                                -
                                                - -
                                                -
                                                -
                                                -
                                                - - -

                                                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 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 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` +GenericError | @auth0/auth0-angular
                                                  +
                                                  @auth0/auth0-angular + +
                                                    +
                                                    +
                                                    Preparing search index...
                                                    +
                                                    +
                                                    +
                                                    + +

                                                    Class GenericError

                                                    +
                                                    +

                                                    Thrown when network requests to the Auth server fail.

                                                    +
                                                    +
                                                    +

                                                    Hierarchy (View Summary)

                                                    +
                                                    +
                                                    +
                                                    +
                                                    +
                                                    Index
                                                    +
                                                    +
                                                    + +
                                                    +
                                                    + +
                                                      +
                                                    • + +
                                                      +
                                                      +

                                                      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.

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

                                                      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`
                                                      -

                                                      - The first line of the trace will be prefixed with - ${myObject.name}: ${myObject.message}. -

                                                      -

                                                      - The optional constructorOpt argument - accepts a function. If given, all frames above - constructorOpt, including - constructorOpt, will be omitted from the - generated stack trace. -

                                                      -

                                                      - The constructorOpt argument is useful for - hiding implementation details of error generation from - the user. For instance: -

                                                      -
                                                      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(); +

                                                      The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

                                                      +

                                                      The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

                                                      +

                                                      The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

                                                      +
                                                      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 -

                                                      - -
                                                      -
                                                    • -
                                                    -
                                                    -
                                                    - -
                                                      -
                                                    • - -
                                                      -
                                                      -

                                                      Parameters

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

                                                      - Returns any -

                                                      - - -
                                                      -
                                                    • -
                                                    -
                                                    -
                                                    -
                                                    -
                                                    -
                                                    - - -
                                                    -
                                                    -
                                                    -
                                                    - - + +
                                                    +
                                                    +

                                                    Parameters

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

                                                    Returns void

                                                  +
                                                  + +
                                                    +
                                                  • + +
                                                    +
                                                    +

                                                    Parameters

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

                                                    Returns GenericError

                                                  +
                                                  + +
                                                  +
                                                  + +
                                                  +
                                                  diff --git a/docs/classes/InMemoryCache.html b/docs/classes/InMemoryCache.html index 76a223a7..e1ff38c9 100644 --- a/docs/classes/InMemoryCache.html +++ b/docs/classes/InMemoryCache.html @@ -1,3 +1,69 @@ -InMemoryCache | @auth0/auth0-angular
                                                  @auth0/auth0-angular
                                                    Preparing search index...

                                                    Class InMemoryCache

                                                    Index

                                                    Constructors

                                                    Properties

                                                    Constructors

                                                    Properties

                                                    enclosedCache: ICache
                                                    +InMemoryCache | @auth0/auth0-angular
                                                    +
                                                    @auth0/auth0-angular + +
                                                      +
                                                      +
                                                      Preparing search index...
                                                      +
                                                      +
                                                      +
                                                      + +

                                                      Class InMemoryCache

                                                      +
                                                      +
                                                      +
                                                      +
                                                      Index
                                                      +
                                                      +
                                                      + +
                                                      +
                                                      + +
                                                      +
                                                      + +
                                                      +
                                                      + +
                                                      +
                                                      + +
                                                      +
                                                      + +
                                                      enclosedCache: ICache
                                                      +
                                                      + +
                                                      +
                                                      diff --git a/docs/classes/InvalidConfigurationError.html b/docs/classes/InvalidConfigurationError.html new file mode 100644 index 00000000..f3d5915e --- /dev/null +++ b/docs/classes/InvalidConfigurationError.html @@ -0,0 +1,213 @@ +InvalidConfigurationError | @auth0/auth0-angular
                                                      +
                                                      @auth0/auth0-angular + +
                                                        +
                                                        +
                                                        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
                                                        +
                                                        +
                                                        + +
                                                        +
                                                        + +
                                                        +
                                                        + +
                                                        +
                                                        + +
                                                        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.

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

                                                          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` +
                                                          + +

                                                          The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

                                                          +

                                                          The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

                                                          +

                                                          The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

                                                          +
                                                          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

                                                        +
                                                        + +
                                                        +
                                                        + +
                                                        +
                                                        diff --git a/docs/classes/LocalStorageCache.html b/docs/classes/LocalStorageCache.html index 2b23f79f..45e87f09 100644 --- a/docs/classes/LocalStorageCache.html +++ b/docs/classes/LocalStorageCache.html @@ -1,6 +1,132 @@ -LocalStorageCache | @auth0/auth0-angular
                                                        @auth0/auth0-angular
                                                          Preparing search index...

                                                          Class LocalStorageCache

                                                          Implements

                                                          Index

                                                          Constructors

                                                          Methods

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

                                                            Class LocalStorageCache

                                                            +
                                                            +

                                                            Implements

                                                            +
                                                            +
                                                            +
                                                            +
                                                            +
                                                            Index
                                                            +
                                                            +
                                                            + +
                                                            +
                                                            + +

                                                            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

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

                                                              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

                                                            +
                                                            + +
                                                            +
                                                            diff --git a/docs/classes/MfaChallengeError.html b/docs/classes/MfaChallengeError.html index 0f16357c..cce7d9ae 100644 --- a/docs/classes/MfaChallengeError.html +++ b/docs/classes/MfaChallengeError.html @@ -1,1243 +1,212 @@ - - - - - - MfaChallengeError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                            -
                                                            - @auth0/auth0-angular - - - - -
                                                              -
                                                              -
                                                              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-angular
                                                              +
                                                              @auth0/auth0-angular + +
                                                                +
                                                                +
                                                                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) -

                                                                -
                                                                  -
                                                                • - MfaError -
                                                                    -
                                                                  • - MfaChallengeError -
                                                                  • -
                                                                  -
                                                                • -
                                                                -
                                                                - -
                                                                -
                                                                -
                                                                - - -
                                                                Index
                                                                -
                                                                - -
                                                                -
                                                                -
                                                                -
                                                                - - -

                                                                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 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 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` + +
                                                                +
                                                                +

                                                                Hierarchy (View Summary)

                                                                +
                                                                +
                                                                +
                                                                +
                                                                +
                                                                Index
                                                                +
                                                                +
                                                                + +
                                                                +
                                                                + +
                                                                  +
                                                                • + +
                                                                  +
                                                                  +

                                                                  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.

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

                                                                  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`
                                                                  -

                                                                  - The first line of the trace will be prefixed with - ${myObject.name}: ${myObject.message}. -

                                                                  -

                                                                  - The optional constructorOpt argument - accepts a function. If given, all frames above - constructorOpt, including - constructorOpt, will be omitted from the - generated stack trace. -

                                                                  -

                                                                  - The constructorOpt argument is useful for - hiding implementation details of error generation from - the user. For instance: -

                                                                  -
                                                                  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(); +

                                                                  The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

                                                                  +

                                                                  The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

                                                                  +

                                                                  The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

                                                                  +
                                                                  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 -

                                                                  - -
                                                                  -
                                                                • -
                                                                -
                                                                -
                                                                - - -
                                                                -
                                                                -
                                                                -
                                                                -
                                                                - - -
                                                                -
                                                                -
                                                                -
                                                                - - + +
                                                                +
                                                                +

                                                                Parameters

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

                                                                Returns void

                                                                +
                                                                + +
                                                                  +
                                                                • + +
                                                                  +
                                                                  +

                                                                  Parameters

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

                                                                  Returns MfaError

                                                                +
                                                                + +
                                                                +
                                                                + +
                                                                +
                                                                diff --git a/docs/classes/MfaEnrollmentError.html b/docs/classes/MfaEnrollmentError.html index 90c79314..758c0503 100644 --- a/docs/classes/MfaEnrollmentError.html +++ b/docs/classes/MfaEnrollmentError.html @@ -1,1243 +1,212 @@ - - - - - - MfaEnrollmentError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                -
                                                                - @auth0/auth0-angular - - - - -
                                                                  -
                                                                  -
                                                                  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-angular
                                                                  +
                                                                  @auth0/auth0-angular + +
                                                                    +
                                                                    +
                                                                    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) -

                                                                    -
                                                                      -
                                                                    • - MfaError -
                                                                        -
                                                                      • - MfaEnrollmentError -
                                                                      • -
                                                                      -
                                                                    • -
                                                                    -
                                                                    - -
                                                                    -
                                                                    -
                                                                    - - -
                                                                    Index
                                                                    -
                                                                    - -
                                                                    -
                                                                    -
                                                                    -
                                                                    - - -

                                                                    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 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 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` + +
                                                                    +
                                                                    +

                                                                    Hierarchy (View Summary)

                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    Index
                                                                    +
                                                                    +
                                                                    + +
                                                                    +
                                                                    + +
                                                                      +
                                                                    • + +
                                                                      +
                                                                      +

                                                                      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.

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

                                                                      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`
                                                                      -

                                                                      - The first line of the trace will be prefixed with - ${myObject.name}: ${myObject.message}. -

                                                                      -

                                                                      - The optional constructorOpt argument - accepts a function. If given, all frames above - constructorOpt, including - constructorOpt, will be omitted from the - generated stack trace. -

                                                                      -

                                                                      - The constructorOpt argument is useful for - hiding implementation details of error generation from - the user. For instance: -

                                                                      -
                                                                      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(); +

                                                                      The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

                                                                      +

                                                                      The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

                                                                      +

                                                                      The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

                                                                      +
                                                                      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 -

                                                                      - -
                                                                      -
                                                                    • -
                                                                    -
                                                                    -
                                                                    - - -
                                                                    -
                                                                    -
                                                                    -
                                                                    -
                                                                    - - -
                                                                    -
                                                                    -
                                                                    -
                                                                    - - + +
                                                                    +
                                                                    +

                                                                    Parameters

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

                                                                    Returns void

                                                                    +
                                                                    + +
                                                                      +
                                                                    • + +
                                                                      +
                                                                      +

                                                                      Parameters

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

                                                                      Returns MfaError

                                                                    +
                                                                    + +
                                                                    +
                                                                    + +
                                                                    +
                                                                    diff --git a/docs/classes/MfaEnrollmentFactorsError.html b/docs/classes/MfaEnrollmentFactorsError.html index dfbd5ea9..2397f219 100644 --- a/docs/classes/MfaEnrollmentFactorsError.html +++ b/docs/classes/MfaEnrollmentFactorsError.html @@ -1,1247 +1,212 @@ - - - - - - MfaEnrollmentFactorsError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                    -
                                                                    - @auth0/auth0-angular - - - - -
                                                                      -
                                                                      -
                                                                      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-angular
                                                                      +
                                                                      @auth0/auth0-angular + +
                                                                        +
                                                                        +
                                                                        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) -

                                                                        -
                                                                          -
                                                                        • - MfaError -
                                                                            -
                                                                          • - MfaEnrollmentFactorsError -
                                                                          • -
                                                                          -
                                                                        • -
                                                                        -
                                                                        - -
                                                                        -
                                                                        -
                                                                        - - -
                                                                        Index
                                                                        -
                                                                        - -
                                                                        -
                                                                        -
                                                                        -
                                                                        - - -

                                                                        Constructors

                                                                        -
                                                                        -
                                                                        -
                                                                        - -
                                                                          -
                                                                        • - -
                                                                          -
                                                                          -

                                                                          Parameters

                                                                          -
                                                                            -
                                                                          • - error: - string -
                                                                          • -
                                                                          • - error_description: - string -
                                                                          • -
                                                                          -
                                                                          -

                                                                          - Returns - MfaEnrollmentFactorsError -

                                                                          - -
                                                                          -
                                                                        • -
                                                                        -
                                                                        -
                                                                        -
                                                                        -
                                                                        - - -

                                                                        Properties

                                                                        -
                                                                        -
                                                                        -
                                                                        - -
                                                                        - 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 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` + +
                                                                        +
                                                                        +

                                                                        Hierarchy (View Summary)

                                                                        +
                                                                        +
                                                                        +
                                                                        +
                                                                        +
                                                                        Index
                                                                        +
                                                                        +
                                                                        + +
                                                                        +
                                                                        + +
                                                                        +
                                                                        + +
                                                                        +
                                                                        + +
                                                                        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.

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

                                                                          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`
                                                                          -

                                                                          - The first line of the trace will be prefixed with - ${myObject.name}: ${myObject.message}. -

                                                                          -

                                                                          - The optional constructorOpt argument - accepts a function. If given, all frames above - constructorOpt, including - constructorOpt, will be omitted from the - generated stack trace. -

                                                                          -

                                                                          - The constructorOpt argument is useful for - hiding implementation details of error generation from - the user. For instance: -

                                                                          -
                                                                          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(); +

                                                                          The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

                                                                          +

                                                                          The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

                                                                          +

                                                                          The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

                                                                          +
                                                                          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 -

                                                                          - -
                                                                          -
                                                                        • -
                                                                        -
                                                                        -
                                                                        - - -
                                                                        -
                                                                        -
                                                                        -
                                                                        -
                                                                        - - -
                                                                        -
                                                                        -
                                                                        -
                                                                        - - + +
                                                                        +
                                                                        +

                                                                        Parameters

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

                                                                        Returns void

                                                                        +
                                                                        + +
                                                                          +
                                                                        • + +
                                                                          +
                                                                          +

                                                                          Parameters

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

                                                                          Returns MfaError

                                                                        +
                                                                        + +
                                                                        +
                                                                        + +
                                                                        +
                                                                        diff --git a/docs/classes/MfaError.html b/docs/classes/MfaError.html index 389daefd..4cfa8498 100644 --- a/docs/classes/MfaError.html +++ b/docs/classes/MfaError.html @@ -1,1259 +1,213 @@ - - - - - - MfaError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                        -
                                                                        - @auth0/auth0-angular - - - - -
                                                                          -
                                                                          -
                                                                          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

                                                                          -
                                                                          -
                                                                          -
                                                                          - -
                                                                            -
                                                                          • - -
                                                                            -
                                                                            -

                                                                            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 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 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` +MfaError | @auth0/auth0-angular
                                                                            +
                                                                            @auth0/auth0-angular + +
                                                                              +
                                                                              +
                                                                              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
                                                                              +
                                                                              +
                                                                              + +
                                                                              +
                                                                              + +
                                                                                +
                                                                              • + +
                                                                                +
                                                                                +

                                                                                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.

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

                                                                                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`
                                                                                -

                                                                                - The first line of the trace will be prefixed with - ${myObject.name}: ${myObject.message}. -

                                                                                -

                                                                                - The optional constructorOpt argument - accepts a function. If given, all frames above - constructorOpt, including - constructorOpt, will be omitted from the - generated stack trace. -

                                                                                -

                                                                                - The constructorOpt argument is useful for - hiding implementation details of error generation from - the user. For instance: -

                                                                                -
                                                                                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(); +

                                                                                The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

                                                                                +

                                                                                The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

                                                                                +

                                                                                The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

                                                                                +
                                                                                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 -

                                                                                - -
                                                                                -
                                                                              • -
                                                                              -
                                                                              -
                                                                              - - -
                                                                              -
                                                                              -
                                                                              -
                                                                              -
                                                                              - - -
                                                                              -
                                                                              -
                                                                              -
                                                                              - - + +
                                                                              +
                                                                              +

                                                                              Parameters

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

                                                                              Returns void

                                                                            +
                                                                            + +
                                                                              +
                                                                            • + +
                                                                              +
                                                                              +

                                                                              Parameters

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

                                                                              Returns MfaError

                                                                            +
                                                                            + +
                                                                            +
                                                                            + +
                                                                            +
                                                                            diff --git a/docs/classes/MfaListAuthenticatorsError.html b/docs/classes/MfaListAuthenticatorsError.html index 7b3cc90b..3ea72f81 100644 --- a/docs/classes/MfaListAuthenticatorsError.html +++ b/docs/classes/MfaListAuthenticatorsError.html @@ -1,1247 +1,212 @@ - - - - - - MfaListAuthenticatorsError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                            -
                                                                            - @auth0/auth0-angular - - - - -
                                                                              -
                                                                              -
                                                                              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-angular
                                                                              +
                                                                              @auth0/auth0-angular + +
                                                                                +
                                                                                +
                                                                                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) -

                                                                                -
                                                                                  -
                                                                                • - MfaError -
                                                                                    -
                                                                                  • - MfaListAuthenticatorsError -
                                                                                  • -
                                                                                  -
                                                                                • -
                                                                                -
                                                                                - -
                                                                                -
                                                                                -
                                                                                - - -
                                                                                Index
                                                                                -
                                                                                - -
                                                                                -
                                                                                -
                                                                                -
                                                                                - - -

                                                                                Constructors

                                                                                -
                                                                                -
                                                                                -
                                                                                - -
                                                                                  -
                                                                                • - -
                                                                                  -
                                                                                  -

                                                                                  Parameters

                                                                                  -
                                                                                    -
                                                                                  • - error: - string -
                                                                                  • -
                                                                                  • - error_description: - string -
                                                                                  • -
                                                                                  -
                                                                                  -

                                                                                  - Returns - MfaListAuthenticatorsError -

                                                                                  - -
                                                                                  -
                                                                                • -
                                                                                -
                                                                                -
                                                                                -
                                                                                -
                                                                                - - -

                                                                                Properties

                                                                                -
                                                                                -
                                                                                -
                                                                                - -
                                                                                - 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 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` + +
                                                                                +
                                                                                +

                                                                                Hierarchy (View Summary)

                                                                                +
                                                                                  +
                                                                                • MfaError +
                                                                                    +
                                                                                  • MfaListAuthenticatorsError
                                                                                +
                                                                                +
                                                                                +
                                                                                +
                                                                                Index
                                                                                +
                                                                                +
                                                                                + +
                                                                                +
                                                                                + +
                                                                                +
                                                                                + +
                                                                                +
                                                                                + +
                                                                                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.

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

                                                                                  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`
                                                                                  -

                                                                                  - The first line of the trace will be prefixed with - ${myObject.name}: ${myObject.message}. -

                                                                                  -

                                                                                  - The optional constructorOpt argument - accepts a function. If given, all frames above - constructorOpt, including - constructorOpt, will be omitted from the - generated stack trace. -

                                                                                  -

                                                                                  - The constructorOpt argument is useful for - hiding implementation details of error generation from - the user. For instance: -

                                                                                  -
                                                                                  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(); +

                                                                                  The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

                                                                                  +

                                                                                  The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

                                                                                  +

                                                                                  The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

                                                                                  +
                                                                                  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 -

                                                                                  - -
                                                                                  -
                                                                                • -
                                                                                -
                                                                                -
                                                                                - - -
                                                                                -
                                                                                -
                                                                                -
                                                                                -
                                                                                - - -
                                                                                -
                                                                                -
                                                                                -
                                                                                - - + +
                                                                                +
                                                                                +

                                                                                Parameters

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

                                                                                Returns void

                                                                                +
                                                                                + +
                                                                                  +
                                                                                • + +
                                                                                  +
                                                                                  +

                                                                                  Parameters

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

                                                                                  Returns MfaError

                                                                                +
                                                                                + +
                                                                                +
                                                                                + +
                                                                                +
                                                                                diff --git a/docs/classes/MfaRequiredError.html b/docs/classes/MfaRequiredError.html index a2e73873..84f4e7d1 100644 --- a/docs/classes/MfaRequiredError.html +++ b/docs/classes/MfaRequiredError.html @@ -1,1349 +1,220 @@ - - - - - - MfaRequiredError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                -
                                                                                - @auth0/auth0-angular - - - - -
                                                                                  -
                                                                                  -
                                                                                  Preparing search index...
                                                                                  -
                                                                                  -
                                                                                  - -
                                                                                  -
                                                                                  -
                                                                                  -
                                                                                  -
                                                                                  - -

                                                                                  Class MfaRequiredError

                                                                                  -
                                                                                  -
                                                                                  -
                                                                                  -

                                                                                  - Error thrown when the token exchange results in a - mfa_required error -

                                                                                  -
                                                                                  -
                                                                                  -
                                                                                  -

                                                                                  - Hierarchy (View Summary) -

                                                                                  - -
                                                                                  - -
                                                                                  -
                                                                                  -
                                                                                  - - -
                                                                                  Index
                                                                                  -
                                                                                  - -
                                                                                  -
                                                                                  -
                                                                                  -
                                                                                  - - -

                                                                                  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 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 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` +MfaRequiredError | @auth0/auth0-angular
                                                                                    +
                                                                                    @auth0/auth0-angular + +
                                                                                      +
                                                                                      +
                                                                                      Preparing search index...
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      + +

                                                                                      Class MfaRequiredError

                                                                                      +
                                                                                      +

                                                                                      Error thrown when the token exchange results in a mfa_required error

                                                                                      +
                                                                                      +
                                                                                      +

                                                                                      Hierarchy (View Summary)

                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      Index
                                                                                      +
                                                                                      +
                                                                                      + +
                                                                                      +
                                                                                      + +
                                                                                        +
                                                                                      • + +
                                                                                        +
                                                                                        +

                                                                                        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.

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

                                                                                        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`
                                                                                        -

                                                                                        - The first line of the trace will be prefixed with - ${myObject.name}: ${myObject.message}. -

                                                                                        -

                                                                                        - The optional constructorOpt argument - accepts a function. If given, all frames above - constructorOpt, including - constructorOpt, will be omitted from the - generated stack trace. -

                                                                                        -

                                                                                        - The constructorOpt argument is useful for - hiding implementation details of error generation from - the user. For instance: -

                                                                                        -
                                                                                        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(); +

                                                                                        The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

                                                                                        +

                                                                                        The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

                                                                                        +

                                                                                        The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

                                                                                        +
                                                                                        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 -

                                                                                        - -
                                                                                        -
                                                                                      • -
                                                                                      -
                                                                                      -
                                                                                      - - -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      - - -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      - - + +
                                                                                      +
                                                                                      +

                                                                                      Parameters

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

                                                                                      Returns void

                                                                                    +
                                                                                    + +
                                                                                      +
                                                                                    • + +
                                                                                      +
                                                                                      +

                                                                                      Parameters

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

                                                                                      Returns GenericError

                                                                                    +
                                                                                    + +
                                                                                    +
                                                                                    + +
                                                                                    +
                                                                                    diff --git a/docs/classes/MfaVerifyError.html b/docs/classes/MfaVerifyError.html index 04eb0004..dbbf4a20 100644 --- a/docs/classes/MfaVerifyError.html +++ b/docs/classes/MfaVerifyError.html @@ -1,1239 +1,212 @@ - - - - - - MfaVerifyError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                    -
                                                                                    - @auth0/auth0-angular - - - - -
                                                                                      -
                                                                                      -
                                                                                      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-angular
                                                                                      +
                                                                                      @auth0/auth0-angular + +
                                                                                        +
                                                                                        +
                                                                                        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) -

                                                                                        -
                                                                                          -
                                                                                        • - MfaError -
                                                                                            -
                                                                                          • - MfaVerifyError -
                                                                                          • -
                                                                                          -
                                                                                        • -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        Index
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -

                                                                                        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 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 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` + +
                                                                                        +
                                                                                        +

                                                                                        Hierarchy (View Summary)

                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        Index
                                                                                        +
                                                                                        +
                                                                                        + +
                                                                                        +
                                                                                        + +
                                                                                          +
                                                                                        • + +
                                                                                          +
                                                                                          +

                                                                                          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.

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

                                                                                          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`
                                                                                          -

                                                                                          - The first line of the trace will be prefixed with - ${myObject.name}: ${myObject.message}. -

                                                                                          -

                                                                                          - The optional constructorOpt argument - accepts a function. If given, all frames above - constructorOpt, including - constructorOpt, will be omitted from the - generated stack trace. -

                                                                                          -

                                                                                          - The constructorOpt argument is useful for - hiding implementation details of error generation from - the user. For instance: -

                                                                                          -
                                                                                          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(); +

                                                                                          The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

                                                                                          +

                                                                                          The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

                                                                                          +

                                                                                          The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

                                                                                          +
                                                                                          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 -

                                                                                          - -
                                                                                          -
                                                                                        • -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - + +
                                                                                        +
                                                                                        +

                                                                                        Parameters

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

                                                                                        Returns void

                                                                                        +
                                                                                        + +
                                                                                          +
                                                                                        • + +
                                                                                          +
                                                                                          +

                                                                                          Parameters

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

                                                                                          Returns MfaError

                                                                                        +
                                                                                        + +
                                                                                        +
                                                                                        + +
                                                                                        +
                                                                                        diff --git a/docs/classes/MissingRefreshTokenError.html b/docs/classes/MissingRefreshTokenError.html index 86d40e35..5be49997 100644 --- a/docs/classes/MissingRefreshTokenError.html +++ b/docs/classes/MissingRefreshTokenError.html @@ -1,1315 +1,218 @@ - - - - - - MissingRefreshTokenError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                        -
                                                                                        - @auth0/auth0-angular - - - - -
                                                                                          -
                                                                                          -
                                                                                          Preparing search index...
                                                                                          -
                                                                                          -
                                                                                          - -
                                                                                          -
                                                                                          -
                                                                                          -
                                                                                          -
                                                                                          - -

                                                                                          Class MissingRefreshTokenError

                                                                                          -
                                                                                          -
                                                                                          -
                                                                                          -

                                                                                          Error thrown when there is no refresh token to use

                                                                                          -
                                                                                          -
                                                                                          -
                                                                                          -

                                                                                          - Hierarchy (View Summary) -

                                                                                          - -
                                                                                          - -
                                                                                          -
                                                                                          -
                                                                                          - - -
                                                                                          Index
                                                                                          -
                                                                                          - -
                                                                                          -
                                                                                          -
                                                                                          -
                                                                                          - - -

                                                                                          Constructors

                                                                                          -
                                                                                          -
                                                                                          -
                                                                                          - -
                                                                                            -
                                                                                          • - -
                                                                                            -
                                                                                            -

                                                                                            Parameters

                                                                                            -
                                                                                              -
                                                                                            • - audience: - string -
                                                                                            • -
                                                                                            • - scope: - string -
                                                                                            • -
                                                                                            -
                                                                                            -

                                                                                            - Returns - MissingRefreshTokenError -

                                                                                            - -
                                                                                            -
                                                                                          • -
                                                                                          -
                                                                                          -
                                                                                          -
                                                                                          -
                                                                                          - - -

                                                                                          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 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 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` +MissingRefreshTokenError | @auth0/auth0-angular
                                                                                            +
                                                                                            @auth0/auth0-angular + +
                                                                                              +
                                                                                              +
                                                                                              Preparing search index...
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              + +

                                                                                              Class MissingRefreshTokenError

                                                                                              +
                                                                                              +

                                                                                              Error thrown when there is no refresh token to use

                                                                                              +
                                                                                              +
                                                                                              +

                                                                                              Hierarchy (View Summary)

                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              Index
                                                                                              +
                                                                                              +
                                                                                              + +
                                                                                              +
                                                                                              + +
                                                                                              +
                                                                                              + +
                                                                                              +
                                                                                              + +
                                                                                              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.

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

                                                                                                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`
                                                                                                -

                                                                                                - The first line of the trace will be prefixed with - ${myObject.name}: ${myObject.message}. -

                                                                                                -

                                                                                                - The optional constructorOpt argument - accepts a function. If given, all frames above - constructorOpt, including - constructorOpt, will be omitted from the - generated stack trace. -

                                                                                                -

                                                                                                - The constructorOpt argument is useful for - hiding implementation details of error generation from - the user. For instance: -

                                                                                                -
                                                                                                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(); +

                                                                                                The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

                                                                                                +

                                                                                                The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

                                                                                                +

                                                                                                The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

                                                                                                +
                                                                                                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 -

                                                                                                - -
                                                                                                -
                                                                                              • -
                                                                                              -
                                                                                              -
                                                                                              - - -
                                                                                              -
                                                                                              -
                                                                                              -
                                                                                              -
                                                                                              - - -
                                                                                              -
                                                                                              -
                                                                                              -
                                                                                              - - + +
                                                                                              +
                                                                                              +

                                                                                              Parameters

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

                                                                                              Returns void

                                                                                            +
                                                                                            + +
                                                                                              +
                                                                                            • + +
                                                                                              +
                                                                                              +

                                                                                              Parameters

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

                                                                                              Returns GenericError

                                                                                            +
                                                                                            + +
                                                                                            +
                                                                                            + +
                                                                                            +
                                                                                            diff --git a/docs/classes/MissingScopesError.html b/docs/classes/MissingScopesError.html new file mode 100644 index 00000000..90167212 --- /dev/null +++ b/docs/classes/MissingScopesError.html @@ -0,0 +1,218 @@ +MissingScopesError | @auth0/auth0-angular
                                                                                            +
                                                                                            @auth0/auth0-angular + +
                                                                                              +
                                                                                              +
                                                                                              Preparing search index...
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              + +

                                                                                              Class MissingScopesError

                                                                                              +
                                                                                              +

                                                                                              Error thrown when there are missing scopes after refreshing a token

                                                                                              +
                                                                                              +
                                                                                              +

                                                                                              Hierarchy (View Summary)

                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              Index
                                                                                              +
                                                                                              +
                                                                                              + +
                                                                                              +
                                                                                              + +
                                                                                              +
                                                                                              + +
                                                                                              +
                                                                                              + +
                                                                                              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.

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

                                                                                                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` +
                                                                                                + +

                                                                                                The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

                                                                                                +

                                                                                                The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

                                                                                                +

                                                                                                The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

                                                                                                +
                                                                                                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

                                                                                              +
                                                                                              + +
                                                                                              +
                                                                                              + +
                                                                                              +
                                                                                              diff --git a/docs/classes/MyAccountApiError.html b/docs/classes/MyAccountApiError.html index f01aedde..5ff8408a 100644 --- a/docs/classes/MyAccountApiError.html +++ b/docs/classes/MyAccountApiError.html @@ -1,1219 +1,222 @@ - - - - - - MyAccountApiError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                              -
                                                                                              - @auth0/auth0-angular - - - - -
                                                                                                -
                                                                                                -
                                                                                                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-angular
                                                                                                +
                                                                                                @auth0/auth0-angular + +
                                                                                                  +
                                                                                                  +
                                                                                                  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

                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  - -
                                                                                                    -
                                                                                                  • - -
                                                                                                    -
                                                                                                    -

                                                                                                    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 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 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` + +
                                                                                                  +
                                                                                                  +

                                                                                                  Hierarchy

                                                                                                  +
                                                                                                    +
                                                                                                  • Error +
                                                                                                      +
                                                                                                    • MyAccountApiError
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  Index
                                                                                                  +
                                                                                                  +
                                                                                                  + +
                                                                                                  +
                                                                                                  + +
                                                                                                    +
                                                                                                  • + +
                                                                                                    +
                                                                                                    +

                                                                                                    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.

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

                                                                                                    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`
                                                                                                    -

                                                                                                    - The first line of the trace will be prefixed with - ${myObject.name}: ${myObject.message}. -

                                                                                                    -

                                                                                                    - The optional constructorOpt argument - accepts a function. If given, all frames above - constructorOpt, including - constructorOpt, will be omitted from the - generated stack trace. -

                                                                                                    -

                                                                                                    - The constructorOpt argument is useful for - hiding implementation details of error generation from - the user. For instance: -

                                                                                                    -
                                                                                                    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(); +

                                                                                                    The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

                                                                                                    +

                                                                                                    The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

                                                                                                    +

                                                                                                    The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

                                                                                                    +
                                                                                                    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

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

                                                                                                    - Returns any -

                                                                                                    - - -
                                                                                                    -
                                                                                                  • -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  - - -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  - - + +
                                                                                                  +
                                                                                                  +

                                                                                                  Parameters

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

                                                                                                  Returns void

                                                                                                  +
                                                                                                  + +
                                                                                                  +
                                                                                                  + +
                                                                                                  +
                                                                                                  diff --git a/docs/classes/PasskeyChallengeError.html b/docs/classes/PasskeyChallengeError.html index 5d9ffcd8..18a921d0 100644 --- a/docs/classes/PasskeyChallengeError.html +++ b/docs/classes/PasskeyChallengeError.html @@ -1,1059 +1,191 @@ - - - - - - PasskeyChallengeError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                  -
                                                                                                  - @auth0/auth0-angular - - - - -
                                                                                                    -
                                                                                                    -
                                                                                                    Preparing search index...
                                                                                                    -
                                                                                                    -
                                                                                                    - -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    - -

                                                                                                    Class PasskeyChallengeError

                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -

                                                                                                    Error thrown when requesting a passkey login challenge fails.

                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -

                                                                                                    Hierarchy

                                                                                                    -
                                                                                                      -
                                                                                                    • - PasskeyError -
                                                                                                        -
                                                                                                      • - PasskeyChallengeError -
                                                                                                      • -
                                                                                                      -
                                                                                                    • -
                                                                                                    -
                                                                                                    - -
                                                                                                    -
                                                                                                    -
                                                                                                    - - -
                                                                                                    Index
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -

                                                                                                    Constructors

                                                                                                    - -
                                                                                                    -
                                                                                                    -

                                                                                                    Properties

                                                                                                    - -
                                                                                                    -
                                                                                                    -

                                                                                                    Methods

                                                                                                    - -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    - - -

                                                                                                    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 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 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` +PasskeyChallengeError | @auth0/auth0-angular
                                                                                                      +
                                                                                                      @auth0/auth0-angular + +
                                                                                                        +
                                                                                                        +
                                                                                                        Preparing search index...
                                                                                                        +
                                                                                                        +
                                                                                                        +
                                                                                                        + +

                                                                                                        Class PasskeyChallengeError

                                                                                                        +
                                                                                                        +

                                                                                                        Error thrown when requesting a passkey login challenge fails.

                                                                                                        +
                                                                                                        +
                                                                                                        +

                                                                                                        Hierarchy

                                                                                                        +
                                                                                                          +
                                                                                                        • PasskeyError +
                                                                                                            +
                                                                                                          • PasskeyChallengeError
                                                                                                        +
                                                                                                        +
                                                                                                        +
                                                                                                        +
                                                                                                        Index
                                                                                                        +
                                                                                                        +
                                                                                                        + +
                                                                                                        +
                                                                                                        + +
                                                                                                        +
                                                                                                        + +
                                                                                                        +
                                                                                                        + +
                                                                                                        +
                                                                                                        + +
                                                                                                          +
                                                                                                        • + +
                                                                                                          +
                                                                                                          +

                                                                                                          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.

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

                                                                                                          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`
                                                                                                          -

                                                                                                          - The first line of the trace will be prefixed with - ${myObject.name}: ${myObject.message}. -

                                                                                                          -

                                                                                                          - The optional constructorOpt argument - accepts a function. If given, all frames above - constructorOpt, including - constructorOpt, will be omitted from the - generated stack trace. -

                                                                                                          -

                                                                                                          - The constructorOpt argument is useful for - hiding implementation details of error generation from - the user. For instance: -

                                                                                                          -
                                                                                                          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(); +

                                                                                                          The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

                                                                                                          +

                                                                                                          The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

                                                                                                          +

                                                                                                          The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

                                                                                                          +
                                                                                                          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

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

                                                                                                          - Returns any -

                                                                                                          - - -
                                                                                                          -
                                                                                                        • -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        - - -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        - - + +
                                                                                                        +
                                                                                                        +

                                                                                                        Parameters

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

                                                                                                        Returns void

                                                                                                      +
                                                                                                      + +
                                                                                                        +
                                                                                                      • + +
                                                                                                        +
                                                                                                        +

                                                                                                        Parameters

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

                                                                                                        Returns any

                                                                                                        +
                                                                                                      +
                                                                                                      + +
                                                                                                      +
                                                                                                      diff --git a/docs/classes/PasskeyError.html b/docs/classes/PasskeyError.html index 4b53f023..5c4d7afe 100644 --- a/docs/classes/PasskeyError.html +++ b/docs/classes/PasskeyError.html @@ -1,1063 +1,187 @@ - - - - - - PasskeyError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                      -
                                                                                                      - @auth0/auth0-angular - - - - -
                                                                                                        -
                                                                                                        -
                                                                                                        Preparing search index...
                                                                                                        -
                                                                                                        -
                                                                                                        - -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        - -

                                                                                                        Class PasskeyError

                                                                                                        -
                                                                                                        -
                                                                                                        -

                                                                                                        Hierarchy

                                                                                                        -
                                                                                                          -
                                                                                                        • - Error -
                                                                                                            -
                                                                                                          • - PasskeyError -
                                                                                                          • -
                                                                                                          -
                                                                                                        • -
                                                                                                        -
                                                                                                        - -
                                                                                                        -
                                                                                                        -
                                                                                                        - - -
                                                                                                        Index
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -

                                                                                                        Constructors

                                                                                                        - -
                                                                                                        -
                                                                                                        -

                                                                                                        Properties

                                                                                                        - -
                                                                                                        -
                                                                                                        -

                                                                                                        Methods

                                                                                                        - -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        - - -

                                                                                                        Constructors

                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        - -
                                                                                                          -
                                                                                                        • - -
                                                                                                          -
                                                                                                          -

                                                                                                          Parameters

                                                                                                          - -
                                                                                                          -

                                                                                                          - 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 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 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` +PasskeyError | @auth0/auth0-angular
                                                                                                          +
                                                                                                          @auth0/auth0-angular + +
                                                                                                            +
                                                                                                            +
                                                                                                            Preparing search index...
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            + +

                                                                                                            Class PasskeyError

                                                                                                            +
                                                                                                            +

                                                                                                            Hierarchy

                                                                                                            +
                                                                                                              +
                                                                                                            • Error +
                                                                                                                +
                                                                                                              • PasskeyError
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            Index
                                                                                                            +
                                                                                                            +
                                                                                                            + +
                                                                                                            +
                                                                                                            + +
                                                                                                            +
                                                                                                            + +
                                                                                                            +
                                                                                                            + +
                                                                                                            +
                                                                                                            + +
                                                                                                              +
                                                                                                            • + +
                                                                                                              +
                                                                                                              +

                                                                                                              Parameters

                                                                                                              +
                                                                                                              +

                                                                                                              Returns PasskeyError

                                                                                                            +
                                                                                                            + +
                                                                                                            +
                                                                                                            + +
                                                                                                            +
                                                                                                            + +
                                                                                                            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.

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

                                                                                                              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`
                                                                                                              -

                                                                                                              - The first line of the trace will be prefixed with - ${myObject.name}: ${myObject.message}. -

                                                                                                              -

                                                                                                              - The optional constructorOpt argument - accepts a function. If given, all frames above - constructorOpt, including - constructorOpt, will be omitted from the - generated stack trace. -

                                                                                                              -

                                                                                                              - The constructorOpt argument is useful for - hiding implementation details of error generation from - the user. For instance: -

                                                                                                              -
                                                                                                              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(); +

                                                                                                              The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

                                                                                                              +

                                                                                                              The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

                                                                                                              +

                                                                                                              The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

                                                                                                              +
                                                                                                              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

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

                                                                                                              - Returns any -

                                                                                                              - - -
                                                                                                              -
                                                                                                            • -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            - - -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            - - + +
                                                                                                            +
                                                                                                            +

                                                                                                            Parameters

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

                                                                                                            Returns void

                                                                                                          +
                                                                                                          + +
                                                                                                          +
                                                                                                          + +
                                                                                                          +
                                                                                                          diff --git a/docs/classes/PasskeyGetTokenError.html b/docs/classes/PasskeyGetTokenError.html index 7a53b50a..a286948d 100644 --- a/docs/classes/PasskeyGetTokenError.html +++ b/docs/classes/PasskeyGetTokenError.html @@ -1,1063 +1,193 @@ - - - - - - PasskeyGetTokenError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                          -
                                                                                                          - @auth0/auth0-angular - - - - -
                                                                                                            -
                                                                                                            -
                                                                                                            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

                                                                                                            - -
                                                                                                            -
                                                                                                            -

                                                                                                            Properties

                                                                                                            - -
                                                                                                            -
                                                                                                            -

                                                                                                            Methods

                                                                                                            - -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            - - -

                                                                                                            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 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 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` +PasskeyGetTokenError | @auth0/auth0-angular
                                                                                                              +
                                                                                                              @auth0/auth0-angular + +
                                                                                                                +
                                                                                                                +
                                                                                                                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
                                                                                                                +
                                                                                                                +
                                                                                                                + +
                                                                                                                +
                                                                                                                + +
                                                                                                                +
                                                                                                                + +
                                                                                                                +
                                                                                                                + +
                                                                                                                +
                                                                                                                + +
                                                                                                                  +
                                                                                                                • + +
                                                                                                                  +
                                                                                                                  +

                                                                                                                  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.

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

                                                                                                                  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`
                                                                                                                  -

                                                                                                                  - The first line of the trace will be prefixed with - ${myObject.name}: ${myObject.message}. -

                                                                                                                  -

                                                                                                                  - The optional constructorOpt argument - accepts a function. If given, all frames above - constructorOpt, including - constructorOpt, will be omitted from the - generated stack trace. -

                                                                                                                  -

                                                                                                                  - The constructorOpt argument is useful for - hiding implementation details of error generation from - the user. For instance: -

                                                                                                                  -
                                                                                                                  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(); +

                                                                                                                  The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

                                                                                                                  +

                                                                                                                  The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

                                                                                                                  +

                                                                                                                  The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

                                                                                                                  +
                                                                                                                  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

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

                                                                                                                  - Returns any -

                                                                                                                  - - -
                                                                                                                  -
                                                                                                                • -
                                                                                                                -
                                                                                                                -
                                                                                                                -
                                                                                                                -
                                                                                                                -
                                                                                                                - - -
                                                                                                                -
                                                                                                                -
                                                                                                                -
                                                                                                                - - + +
                                                                                                                +
                                                                                                                +

                                                                                                                Parameters

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

                                                                                                                Returns void

                                                                                                              +
                                                                                                              + +
                                                                                                                +
                                                                                                              • + +
                                                                                                                +
                                                                                                                +

                                                                                                                Parameters

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

                                                                                                                Returns any

                                                                                                                +
                                                                                                              +
                                                                                                              + +
                                                                                                              +
                                                                                                              diff --git a/docs/classes/PasskeyRegisterError.html b/docs/classes/PasskeyRegisterError.html index 7eff7296..c63b3531 100644 --- a/docs/classes/PasskeyRegisterError.html +++ b/docs/classes/PasskeyRegisterError.html @@ -1,1059 +1,191 @@ - - - - - - PasskeyRegisterError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                              -
                                                                                                              - @auth0/auth0-angular - - - - -
                                                                                                                -
                                                                                                                -
                                                                                                                Preparing search index...
                                                                                                                -
                                                                                                                -
                                                                                                                - -
                                                                                                                -
                                                                                                                -
                                                                                                                -
                                                                                                                -
                                                                                                                - -

                                                                                                                Class PasskeyRegisterError

                                                                                                                -
                                                                                                                -
                                                                                                                -
                                                                                                                -

                                                                                                                - Error thrown when requesting a passkey register challenge fails. -

                                                                                                                -
                                                                                                                -
                                                                                                                -
                                                                                                                -

                                                                                                                Hierarchy

                                                                                                                -
                                                                                                                  -
                                                                                                                • - PasskeyError -
                                                                                                                    -
                                                                                                                  • - PasskeyRegisterError -
                                                                                                                  • -
                                                                                                                  -
                                                                                                                • -
                                                                                                                -
                                                                                                                - -
                                                                                                                -
                                                                                                                -
                                                                                                                - - -
                                                                                                                Index
                                                                                                                -
                                                                                                                -
                                                                                                                -
                                                                                                                -

                                                                                                                Constructors

                                                                                                                - -
                                                                                                                -
                                                                                                                -

                                                                                                                Properties

                                                                                                                - -
                                                                                                                -
                                                                                                                -

                                                                                                                Methods

                                                                                                                - -
                                                                                                                -
                                                                                                                -
                                                                                                                -
                                                                                                                -
                                                                                                                -
                                                                                                                - - -

                                                                                                                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 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 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` +PasskeyRegisterError | @auth0/auth0-angular
                                                                                                                  +
                                                                                                                  @auth0/auth0-angular + +
                                                                                                                    +
                                                                                                                    +
                                                                                                                    Preparing search index...
                                                                                                                    +
                                                                                                                    +
                                                                                                                    +
                                                                                                                    + +

                                                                                                                    Class PasskeyRegisterError

                                                                                                                    +
                                                                                                                    +

                                                                                                                    Error thrown when requesting a passkey register challenge fails.

                                                                                                                    +
                                                                                                                    +
                                                                                                                    +

                                                                                                                    Hierarchy

                                                                                                                    +
                                                                                                                      +
                                                                                                                    • PasskeyError +
                                                                                                                        +
                                                                                                                      • PasskeyRegisterError
                                                                                                                    +
                                                                                                                    +
                                                                                                                    +
                                                                                                                    +
                                                                                                                    Index
                                                                                                                    +
                                                                                                                    +
                                                                                                                    + +
                                                                                                                    +
                                                                                                                    + +
                                                                                                                    +
                                                                                                                    + +
                                                                                                                    +
                                                                                                                    + +
                                                                                                                    +
                                                                                                                    + +
                                                                                                                      +
                                                                                                                    • + +
                                                                                                                      +
                                                                                                                      +

                                                                                                                      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.

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

                                                                                                                      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`
                                                                                                                      -

                                                                                                                      - The first line of the trace will be prefixed with - ${myObject.name}: ${myObject.message}. -

                                                                                                                      -

                                                                                                                      - The optional constructorOpt argument - accepts a function. If given, all frames above - constructorOpt, including - constructorOpt, will be omitted from the - generated stack trace. -

                                                                                                                      -

                                                                                                                      - The constructorOpt argument is useful for - hiding implementation details of error generation from - the user. For instance: -

                                                                                                                      -
                                                                                                                      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(); +

                                                                                                                      The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

                                                                                                                      +

                                                                                                                      The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

                                                                                                                      +

                                                                                                                      The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

                                                                                                                      +
                                                                                                                      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

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

                                                                                                                      - Returns any -

                                                                                                                      - - -
                                                                                                                      -
                                                                                                                    • -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    - - -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    - - + +
                                                                                                                    +
                                                                                                                    +

                                                                                                                    Parameters

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

                                                                                                                    Returns void

                                                                                                                  +
                                                                                                                  + +
                                                                                                                    +
                                                                                                                  • + +
                                                                                                                    +
                                                                                                                    +

                                                                                                                    Parameters

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

                                                                                                                    Returns any

                                                                                                                    +
                                                                                                                  +
                                                                                                                  + +
                                                                                                                  +
                                                                                                                  diff --git a/docs/classes/PopupCancelledError.html b/docs/classes/PopupCancelledError.html index 0edd552a..a9db27c2 100644 --- a/docs/classes/PopupCancelledError.html +++ b/docs/classes/PopupCancelledError.html @@ -1,1257 +1,211 @@ - - - - - - PopupCancelledError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                  -
                                                                                                                  - @auth0/auth0-angular - - - - -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    Preparing search index...
                                                                                                                    -
                                                                                                                    -
                                                                                                                    - -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    - -

                                                                                                                    Class PopupCancelledError

                                                                                                                    -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    -

                                                                                                                    Thrown when network requests to the Auth server fail.

                                                                                                                    -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    -

                                                                                                                    - Hierarchy (View Summary) -

                                                                                                                    - -
                                                                                                                    - -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    - - -
                                                                                                                    Index
                                                                                                                    -
                                                                                                                    - -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    - - -

                                                                                                                    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 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 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` +PopupCancelledError | @auth0/auth0-angular
                                                                                                                      +
                                                                                                                      @auth0/auth0-angular + +
                                                                                                                        +
                                                                                                                        +
                                                                                                                        Preparing search index...
                                                                                                                        +
                                                                                                                        +
                                                                                                                        +
                                                                                                                        + +

                                                                                                                        Class PopupCancelledError

                                                                                                                        +
                                                                                                                        +

                                                                                                                        Thrown when network requests to the Auth server fail.

                                                                                                                        +
                                                                                                                        +
                                                                                                                        +

                                                                                                                        Hierarchy (View Summary)

                                                                                                                        +
                                                                                                                        +
                                                                                                                        +
                                                                                                                        +
                                                                                                                        +
                                                                                                                        Index
                                                                                                                        +
                                                                                                                        +
                                                                                                                        + +
                                                                                                                        +
                                                                                                                        + +
                                                                                                                        +
                                                                                                                        + +
                                                                                                                        +
                                                                                                                        + +
                                                                                                                        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.

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

                                                                                                                          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`
                                                                                                                          -

                                                                                                                          - The first line of the trace will be prefixed with - ${myObject.name}: ${myObject.message}. -

                                                                                                                          -

                                                                                                                          - The optional constructorOpt argument - accepts a function. If given, all frames above - constructorOpt, including - constructorOpt, will be omitted from the - generated stack trace. -

                                                                                                                          -

                                                                                                                          - The constructorOpt argument is useful for - hiding implementation details of error generation from - the user. For instance: -

                                                                                                                          -
                                                                                                                          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(); +

                                                                                                                          The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

                                                                                                                          +

                                                                                                                          The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

                                                                                                                          +

                                                                                                                          The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

                                                                                                                          +
                                                                                                                          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 -

                                                                                                                          - -
                                                                                                                          -
                                                                                                                        • -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        - - -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        - - -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        - - + +
                                                                                                                        +
                                                                                                                        +

                                                                                                                        Parameters

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

                                                                                                                        Returns void

                                                                                                                      +
                                                                                                                      + +
                                                                                                                        +
                                                                                                                      • + +
                                                                                                                        +
                                                                                                                        +

                                                                                                                        Parameters

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

                                                                                                                        Returns GenericError

                                                                                                                      +
                                                                                                                      + +
                                                                                                                      +
                                                                                                                      + +
                                                                                                                      +
                                                                                                                      diff --git a/docs/classes/PopupOpenError.html b/docs/classes/PopupOpenError.html index 2de85c53..0c99adcf 100644 --- a/docs/classes/PopupOpenError.html +++ b/docs/classes/PopupOpenError.html @@ -1,1203 +1,201 @@ - - - - - - PopupOpenError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                      -
                                                                                                                      - @auth0/auth0-angular - - - - -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        Preparing search index...
                                                                                                                        -
                                                                                                                        -
                                                                                                                        - -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        - -

                                                                                                                        Class PopupOpenError

                                                                                                                        -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        -

                                                                                                                        Thrown when network requests to the Auth server fail.

                                                                                                                        -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        -

                                                                                                                        - Hierarchy (View Summary) -

                                                                                                                        - -
                                                                                                                        - -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        - - -
                                                                                                                        Index
                                                                                                                        -
                                                                                                                        - -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        - - -

                                                                                                                        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 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 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` +PopupOpenError | @auth0/auth0-angular
                                                                                                                          +
                                                                                                                          @auth0/auth0-angular + +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            Preparing search index...
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            + +

                                                                                                                            Class PopupOpenError

                                                                                                                            +
                                                                                                                            +

                                                                                                                            Thrown when network requests to the Auth server fail.

                                                                                                                            +
                                                                                                                            +
                                                                                                                            +

                                                                                                                            Hierarchy (View Summary)

                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            Index
                                                                                                                            +
                                                                                                                            +
                                                                                                                            + +
                                                                                                                            +
                                                                                                                            + +
                                                                                                                            +
                                                                                                                            + +
                                                                                                                            +
                                                                                                                            + +
                                                                                                                            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.

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

                                                                                                                              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`
                                                                                                                              -

                                                                                                                              - The first line of the trace will be prefixed with - ${myObject.name}: ${myObject.message}. -

                                                                                                                              -

                                                                                                                              - The optional constructorOpt argument - accepts a function. If given, all frames above - constructorOpt, including - constructorOpt, will be omitted from the - generated stack trace. -

                                                                                                                              -

                                                                                                                              - The constructorOpt argument is useful for - hiding implementation details of error generation from - the user. For instance: -

                                                                                                                              -
                                                                                                                              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(); +

                                                                                                                              The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

                                                                                                                              +

                                                                                                                              The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

                                                                                                                              +

                                                                                                                              The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

                                                                                                                              +
                                                                                                                              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 -

                                                                                                                              - -
                                                                                                                              -
                                                                                                                            • -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            - - -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            - - -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            - - + +
                                                                                                                            +
                                                                                                                            +

                                                                                                                            Parameters

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

                                                                                                                            Returns void

                                                                                                                          +
                                                                                                                          + +
                                                                                                                            +
                                                                                                                          • + +
                                                                                                                            +
                                                                                                                            +

                                                                                                                            Parameters

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

                                                                                                                            Returns GenericError

                                                                                                                          +
                                                                                                                          + +
                                                                                                                          +
                                                                                                                          + +
                                                                                                                          +
                                                                                                                          diff --git a/docs/classes/PopupTimeoutError.html b/docs/classes/PopupTimeoutError.html index 05c74d62..04a3893d 100644 --- a/docs/classes/PopupTimeoutError.html +++ b/docs/classes/PopupTimeoutError.html @@ -1,1260 +1,211 @@ - - - - - - PopupTimeoutError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                          -
                                                                                                                          - @auth0/auth0-angular - - - - -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            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

                                                                                                                            -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            - - -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            - - -

                                                                                                                            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 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 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` +PopupTimeoutError | @auth0/auth0-angular
                                                                                                                              +
                                                                                                                              @auth0/auth0-angular + +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                Preparing search index...
                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                + +

                                                                                                                                Class PopupTimeoutError

                                                                                                                                +
                                                                                                                                +

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

                                                                                                                                +
                                                                                                                                +
                                                                                                                                +

                                                                                                                                Hierarchy (View Summary)

                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                Index
                                                                                                                                +
                                                                                                                                +
                                                                                                                                + +
                                                                                                                                +
                                                                                                                                + +
                                                                                                                                +
                                                                                                                                + +
                                                                                                                                +
                                                                                                                                + +
                                                                                                                                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.

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

                                                                                                                                  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`
                                                                                                                                  -

                                                                                                                                  - The first line of the trace will be prefixed with - ${myObject.name}: ${myObject.message}. -

                                                                                                                                  -

                                                                                                                                  - The optional constructorOpt argument - accepts a function. If given, all frames above - constructorOpt, including - constructorOpt, will be omitted from the - generated stack trace. -

                                                                                                                                  -

                                                                                                                                  - The constructorOpt argument is useful for - hiding implementation details of error generation from - the user. For instance: -

                                                                                                                                  -
                                                                                                                                  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(); +

                                                                                                                                  The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

                                                                                                                                  +

                                                                                                                                  The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

                                                                                                                                  +

                                                                                                                                  The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

                                                                                                                                  +
                                                                                                                                  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 -

                                                                                                                                  - -
                                                                                                                                  -
                                                                                                                                • -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                - - -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                - - -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                - - + +
                                                                                                                                +
                                                                                                                                +

                                                                                                                                Parameters

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

                                                                                                                                Returns void

                                                                                                                              +
                                                                                                                              + +
                                                                                                                                +
                                                                                                                              • + +
                                                                                                                                +
                                                                                                                                +

                                                                                                                                Parameters

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

                                                                                                                                Returns GenericError

                                                                                                                              +
                                                                                                                              + +
                                                                                                                              +
                                                                                                                              + +
                                                                                                                              +
                                                                                                                              diff --git a/docs/classes/TimeoutError.html b/docs/classes/TimeoutError.html index 5b55b1d3..cac5cf1d 100644 --- a/docs/classes/TimeoutError.html +++ b/docs/classes/TimeoutError.html @@ -1,1214 +1,204 @@ - - - - - - TimeoutError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                              -
                                                                                                                              - @auth0/auth0-angular - - - - -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                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

                                                                                                                                -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                - - -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                - - -

                                                                                                                                Properties

                                                                                                                                -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                - -
                                                                                                                                - 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 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` +TimeoutError | @auth0/auth0-angular
                                                                                                                                  +
                                                                                                                                  @auth0/auth0-angular + +
                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                    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
                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                    + +
                                                                                                                                    +
                                                                                                                                    + +
                                                                                                                                    +
                                                                                                                                    + +
                                                                                                                                    +
                                                                                                                                    + +
                                                                                                                                    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.

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

                                                                                                                                      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`
                                                                                                                                      -

                                                                                                                                      - The first line of the trace will be prefixed with - ${myObject.name}: ${myObject.message}. -

                                                                                                                                      -

                                                                                                                                      - The optional constructorOpt argument - accepts a function. If given, all frames above - constructorOpt, including - constructorOpt, will be omitted from the - generated stack trace. -

                                                                                                                                      -

                                                                                                                                      - The constructorOpt argument is useful for - hiding implementation details of error generation from - the user. For instance: -

                                                                                                                                      -
                                                                                                                                      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(); +

                                                                                                                                      The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

                                                                                                                                      +

                                                                                                                                      The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

                                                                                                                                      +

                                                                                                                                      The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

                                                                                                                                      +
                                                                                                                                      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 -

                                                                                                                                      - -
                                                                                                                                      -
                                                                                                                                    • -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    - - -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    - - -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    - - + +
                                                                                                                                    +
                                                                                                                                    +

                                                                                                                                    Parameters

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

                                                                                                                                    Returns void

                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                    +
                                                                                                                                  • + +
                                                                                                                                    +
                                                                                                                                    +

                                                                                                                                    Parameters

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

                                                                                                                                    Returns GenericError

                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                  +
                                                                                                                                  diff --git a/docs/classes/UseDpopNonceError.html b/docs/classes/UseDpopNonceError.html index e18d6a8f..a1e55d03 100644 --- a/docs/classes/UseDpopNonceError.html +++ b/docs/classes/UseDpopNonceError.html @@ -1,1273 +1,211 @@ - - - - - - UseDpopNonceError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                  -
                                                                                                                                  - @auth0/auth0-angular - - - - -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    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

                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                      -
                                                                                                                                    • - -
                                                                                                                                      -
                                                                                                                                      -

                                                                                                                                      Parameters

                                                                                                                                      -
                                                                                                                                        -
                                                                                                                                      • - newDpopNonce: string - | - undefined -
                                                                                                                                      • -
                                                                                                                                      -
                                                                                                                                      -

                                                                                                                                      - Returns - UseDpopNonceError -

                                                                                                                                      - -
                                                                                                                                      -
                                                                                                                                    • -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    - - -

                                                                                                                                    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 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 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` +UseDpopNonceError | @auth0/auth0-angular
                                                                                                                                      +
                                                                                                                                      @auth0/auth0-angular + +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        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
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        + +
                                                                                                                                        +
                                                                                                                                        + +
                                                                                                                                        +
                                                                                                                                        + +
                                                                                                                                        +
                                                                                                                                        + +
                                                                                                                                        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.

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

                                                                                                                                          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`
                                                                                                                                          -

                                                                                                                                          - The first line of the trace will be prefixed with - ${myObject.name}: ${myObject.message}. -

                                                                                                                                          -

                                                                                                                                          - The optional constructorOpt argument - accepts a function. If given, all frames above - constructorOpt, including - constructorOpt, will be omitted from the - generated stack trace. -

                                                                                                                                          -

                                                                                                                                          - The constructorOpt argument is useful for - hiding implementation details of error generation from - the user. For instance: -

                                                                                                                                          -
                                                                                                                                          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(); +

                                                                                                                                          The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

                                                                                                                                          +

                                                                                                                                          The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

                                                                                                                                          +

                                                                                                                                          The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

                                                                                                                                          +
                                                                                                                                          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 -

                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                        • -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - - -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - - -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - - + +
                                                                                                                                        +
                                                                                                                                        +

                                                                                                                                        Parameters

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

                                                                                                                                        Returns void

                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                        +
                                                                                                                                      • + +
                                                                                                                                        +
                                                                                                                                        +

                                                                                                                                        Parameters

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

                                                                                                                                        Returns GenericError

                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      +
                                                                                                                                      diff --git a/docs/classes/User.html b/docs/classes/User.html index aa3b3ee5..4e615fb4 100644 --- a/docs/classes/User.html +++ b/docs/classes/User.html @@ -1,1328 +1,194 @@ - - - - - - User | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                      -
                                                                                                                                      - @auth0/auth0-angular - - - - -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        Preparing search index...
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - -

                                                                                                                                        Class User

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        Indexable

                                                                                                                                        -
                                                                                                                                          -
                                                                                                                                        • -
                                                                                                                                          - [key: - string]: - any -
                                                                                                                                          -
                                                                                                                                        • -
                                                                                                                                        -
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - - -
                                                                                                                                        Index
                                                                                                                                        -
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - - -

                                                                                                                                        Constructors

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - -
                                                                                                                                          -
                                                                                                                                        • - -
                                                                                                                                          -

                                                                                                                                          - Returns - User -

                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                        • -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - - -

                                                                                                                                        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 -
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - - -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - - +User | @auth0/auth0-angular
                                                                                                                                        +
                                                                                                                                        @auth0/auth0-angular + +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          Preparing search index...
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          + +

                                                                                                                                          Class User

                                                                                                                                          +
                                                                                                                                          +

                                                                                                                                          Indexable

                                                                                                                                          +
                                                                                                                                            +
                                                                                                                                          • +
                                                                                                                                            [key: string]: any
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          Index
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                          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
                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                          +
                                                                                                                                          diff --git a/docs/enums/HttpMethod.html b/docs/enums/HttpMethod.html index c50f649e..11031fd2 100644 --- a/docs/enums/HttpMethod.html +++ b/docs/enums/HttpMethod.html @@ -1,587 +1,86 @@ - - - - - - HttpMethod | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                          -
                                                                                                                                          - @auth0/auth0-angular - - - - -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            Preparing search index...
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - -

                                                                                                                                            Enumeration HttpMethodConst

                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            Defines a common set of HTTP methods.

                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - - -
                                                                                                                                            Index
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            Enumeration Members

                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - - -

                                                                                                                                            Enumeration Members

                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            - Delete: - "DELETE" -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            - Get: - "GET" -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            - Head: - "HEAD" -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            - Patch: - "PATCH" -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            - Post -

                                                                                                                                            -
                                                                                                                                            - Post: - "POST" -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            - Put: - "PUT" -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - - -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - - +HttpMethod | @auth0/auth0-angular
                                                                                                                                            +
                                                                                                                                            @auth0/auth0-angular + +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              Preparing search index...
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              + +

                                                                                                                                              Enumeration HttpMethodConst

                                                                                                                                              +
                                                                                                                                              +

                                                                                                                                              Defines a common set of HTTP methods.

                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              Index
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              + +
                                                                                                                                              +
                                                                                                                                              + +
                                                                                                                                              +
                                                                                                                                              + +
                                                                                                                                              Delete: "DELETE"
                                                                                                                                              +
                                                                                                                                              + +
                                                                                                                                              Get: "GET"
                                                                                                                                              +
                                                                                                                                              + +
                                                                                                                                              Head: "HEAD"
                                                                                                                                              +
                                                                                                                                              + +
                                                                                                                                              Patch: "PATCH"
                                                                                                                                              +
                                                                                                                                              +

                                                                                                                                              Post

                                                                                                                                              +
                                                                                                                                              Post: "POST"
                                                                                                                                              +
                                                                                                                                              + +
                                                                                                                                              Put: "PUT"
                                                                                                                                              +
                                                                                                                                              + +
                                                                                                                                              +
                                                                                                                                              diff --git a/docs/enums/ResponseType.html b/docs/enums/ResponseType.html index 56cba14f..99c0d684 100644 --- a/docs/enums/ResponseType.html +++ b/docs/enums/ResponseType.html @@ -1,8 +1,66 @@ -ResponseType | @auth0/auth0-angular
                                                                                                                                              @auth0/auth0-angular
                                                                                                                                                Preparing search index...

                                                                                                                                                Enumeration ResponseType

                                                                                                                                                The types of responses expected from the authorization server.

                                                                                                                                                +ResponseType | @auth0/auth0-angular
                                                                                                                                                +
                                                                                                                                                @auth0/auth0-angular + +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  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

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Index
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +

                                                                                                                                                  Enumeration Members

                                                                                                                                                  Code: "code"
                                                                                                                                                  ConnectCode: "connect_code"
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  Code: "code"
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  ConnectCode: "connect_code"
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  diff --git a/docs/functions/authGuardFn.html b/docs/functions/authGuardFn.html index 10f8f8b8..d1976a83 100644 --- a/docs/functions/authGuardFn.html +++ b/docs/functions/authGuardFn.html @@ -1,334 +1,50 @@ - - - - - - authGuardFn | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                  -
                                                                                                                                                  - @auth0/auth0-angular - - - - -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    Preparing search index...
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    - -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    - -

                                                                                                                                                    Function authGuardFn

                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                      -
                                                                                                                                                    • - -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      - Functional AuthGuard to ensure routes can only be accessed - when authenticated. -

                                                                                                                                                      -

                                                                                                                                                      Note: Should only be used as of Angular 15

                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      Parameters

                                                                                                                                                      -
                                                                                                                                                        -
                                                                                                                                                      • - route: - ActivatedRouteSnapshot -
                                                                                                                                                        -

                                                                                                                                                        - Contains the information about a route associated with - a component loaded in an outlet at a particular moment - in time. -

                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                      • -
                                                                                                                                                      • - state: - RouterStateSnapshot -
                                                                                                                                                        -

                                                                                                                                                        - Represents the state of the router at a moment in - time. -

                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                      • -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      - Returns Observable<boolean> -

                                                                                                                                                      -

                                                                                                                                                      - An Observable, indicating if the route can be accessed or not -

                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                    • -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    - - -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    - - +authGuardFn | @auth0/auth0-angular
                                                                                                                                                    +
                                                                                                                                                    @auth0/auth0-angular + +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      Preparing search index...
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      + +

                                                                                                                                                      Function authGuardFn

                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                        +
                                                                                                                                                      • + +
                                                                                                                                                        +

                                                                                                                                                        Functional AuthGuard to ensure routes can only be accessed when authenticated.

                                                                                                                                                        +

                                                                                                                                                        Note: Should only be used as of Angular 15

                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        +

                                                                                                                                                        Parameters

                                                                                                                                                        +
                                                                                                                                                          +
                                                                                                                                                        • route: ActivatedRouteSnapshot +

                                                                                                                                                          Contains the information about a route associated with a component loaded in an outlet at a particular moment in time.

                                                                                                                                                          +
                                                                                                                                                        • +
                                                                                                                                                        • state: RouterStateSnapshot +

                                                                                                                                                          Represents the state of the router at a moment in time.

                                                                                                                                                          +
                                                                                                                                                        +

                                                                                                                                                        Returns Observable<boolean>

                                                                                                                                                        An Observable, indicating if the route can be accessed or not

                                                                                                                                                        +
                                                                                                                                                      +
                                                                                                                                                      + +
                                                                                                                                                      +
                                                                                                                                                      diff --git a/docs/functions/authHttpInterceptorFn.html b/docs/functions/authHttpInterceptorFn.html index 80a123c1..ec8b5ac7 100644 --- a/docs/functions/authHttpInterceptorFn.html +++ b/docs/functions/authHttpInterceptorFn.html @@ -1,373 +1,51 @@ - - - - - - authHttpInterceptorFn | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                      -
                                                                                                                                                      - @auth0/auth0-angular - - - - -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        Preparing search index...
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        - -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        - -

                                                                                                                                                        Function authHttpInterceptorFn

                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                          -
                                                                                                                                                        • - -
                                                                                                                                                          -
                                                                                                                                                          -

                                                                                                                                                          - Functional AuthHttpInterceptor to include the access token - in matching requests. -

                                                                                                                                                          -

                                                                                                                                                          Note: Should only be used as of Angular 15

                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -

                                                                                                                                                          Parameters

                                                                                                                                                          -
                                                                                                                                                            -
                                                                                                                                                          • - req: - HttpRequest<any> -
                                                                                                                                                            -

                                                                                                                                                            - An outgoing HTTP request with an optional typed body. -

                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                          • -
                                                                                                                                                          • - handle: - (req: - HttpRequest<unknown>) - => - Observable<HttpEvent<unknown>> -
                                                                                                                                                            -

                                                                                                                                                            - Represents the next interceptor in an interceptor - chain, or the real backend if there are no further - interceptors. -

                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                          • -
                                                                                                                                                          -
                                                                                                                                                          -

                                                                                                                                                          - Returns Observable<HttpEvent<any>> -

                                                                                                                                                          -

                                                                                                                                                          An Observable representing the intercepted HttpRequest

                                                                                                                                                          - -
                                                                                                                                                          -
                                                                                                                                                        • -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        - - +authHttpInterceptorFn | @auth0/auth0-angular
                                                                                                                                                        +
                                                                                                                                                        @auth0/auth0-angular + +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          Preparing search index...
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          + +

                                                                                                                                                          Function authHttpInterceptorFn

                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                            +
                                                                                                                                                          • + +
                                                                                                                                                            +

                                                                                                                                                            Functional AuthHttpInterceptor to include the access token in matching requests.

                                                                                                                                                            +

                                                                                                                                                            Note: Should only be used as of Angular 15

                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            +

                                                                                                                                                            Parameters

                                                                                                                                                            +
                                                                                                                                                              +
                                                                                                                                                            • req: HttpRequest<any> +

                                                                                                                                                              An outgoing HTTP request with an optional typed body.

                                                                                                                                                              +
                                                                                                                                                            • +
                                                                                                                                                            • handle: (req: HttpRequest<unknown>) => Observable<HttpEvent<unknown>> +

                                                                                                                                                              Represents the next interceptor in an interceptor chain, or the real backend if there are no +further interceptors.

                                                                                                                                                              +
                                                                                                                                                            +

                                                                                                                                                            Returns Observable<HttpEvent<any>>

                                                                                                                                                            An Observable representing the intercepted HttpRequest

                                                                                                                                                            +
                                                                                                                                                          +
                                                                                                                                                          + +
                                                                                                                                                          +
                                                                                                                                                          diff --git a/docs/functions/isHttpInterceptorRouteConfig.html b/docs/functions/isHttpInterceptorRouteConfig.html index 1c5facda..6a171ca2 100644 --- a/docs/functions/isHttpInterceptorRouteConfig.html +++ b/docs/functions/isHttpInterceptorRouteConfig.html @@ -1,323 +1,45 @@ - - - - - - isHttpInterceptorRouteConfig | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                          -
                                                                                                                                                          - @auth0/auth0-angular - - - - -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            Preparing search index...
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            - -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            - -

                                                                                                                                                            Function isHttpInterceptorRouteConfig

                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            - -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            - - -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            - - +isHttpInterceptorRouteConfig | @auth0/auth0-angular
                                                                                                                                                            +
                                                                                                                                                            @auth0/auth0-angular + +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              Preparing search index...
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              + +

                                                                                                                                                              Function isHttpInterceptorRouteConfig

                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              + +
                                                                                                                                                              +
                                                                                                                                                              diff --git a/docs/functions/provideAuth0.html b/docs/functions/provideAuth0.html index 77a53cd6..b74ac876 100644 --- a/docs/functions/provideAuth0.html +++ b/docs/functions/provideAuth0.html @@ -1,330 +1,55 @@ - - - - - - provideAuth0 | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                              -
                                                                                                                                                              - @auth0/auth0-angular - - - - -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                Preparing search index...
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                - -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                - -

                                                                                                                                                                Function provideAuth0

                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                  -
                                                                                                                                                                • - -
                                                                                                                                                                  -
                                                                                                                                                                  -

                                                                                                                                                                  - Initialize the authentication system. Configuration can - either be specified here, or by calling AuthClientConfig.set - (perhaps from an APP_INITIALIZER factory function). -

                                                                                                                                                                  -

                                                                                                                                                                  - Note: Should only be used as of Angular 15. This function - returns EnvironmentProviders which ensures it - can only be used at the application/environment level and - cannot be added to a component's providers array (this will - result in a compile-time error). -

                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -

                                                                                                                                                                  Parameters

                                                                                                                                                                  -
                                                                                                                                                                    -
                                                                                                                                                                  • - Optionalconfig: - AuthConfig -
                                                                                                                                                                    -

                                                                                                                                                                    The optional configuration for the SDK.

                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                  • -
                                                                                                                                                                  -
                                                                                                                                                                  -

                                                                                                                                                                  - Returns - EnvironmentProviders -

                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  - -
                                                                                                                                                                  bootstrapApplication(AppComponent, {
                                                                                                                                                                  providers: [
                                                                                                                                                                  provideAuth0(),
                                                                                                                                                                  ],
                                                                                                                                                                  }); +provideAuth0 | @auth0/auth0-angular
                                                                                                                                                                  +
                                                                                                                                                                  @auth0/auth0-angular + +
                                                                                                                                                                    +
                                                                                                                                                                    +
                                                                                                                                                                    Preparing search index...
                                                                                                                                                                    +
                                                                                                                                                                    +
                                                                                                                                                                    +
                                                                                                                                                                    + +

                                                                                                                                                                    Function provideAuth0

                                                                                                                                                                    +
                                                                                                                                                                    +
                                                                                                                                                                      +
                                                                                                                                                                    • + +
                                                                                                                                                                      +

                                                                                                                                                                      Initialize the authentication system. Configuration can either be specified here, +or by calling AuthClientConfig.set (perhaps from an APP_INITIALIZER factory function).

                                                                                                                                                                      +

                                                                                                                                                                      Note: Should only be used as of Angular 15. This function returns EnvironmentProviders +which ensures it can only be used at the application/environment level and cannot be +added to a component's providers array (this will result in a compile-time error).

                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      +

                                                                                                                                                                      Parameters

                                                                                                                                                                      +
                                                                                                                                                                        +
                                                                                                                                                                      • Optionalconfig: AuthConfig +

                                                                                                                                                                        The optional configuration for the SDK.

                                                                                                                                                                        +
                                                                                                                                                                      +

                                                                                                                                                                      Returns EnvironmentProviders

                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      bootstrapApplication(AppComponent, {
                                                                                                                                                                      providers: [
                                                                                                                                                                      provideAuth0(),
                                                                                                                                                                      ],
                                                                                                                                                                      });
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      - -
                                                                                                                                                                      -
                                                                                                                                                                    • -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    - - -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    - - + +
                                                                                                                                                                  +
                                                                                                                                                                  + +
                                                                                                                                                                  +
                                                                                                                                                                  diff --git a/docs/hierarchy.html b/docs/hierarchy.html index 08a0da5c..439bfff8 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -1,465 +1,58 @@ - - - - - - @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                  -
                                                                                                                                                                  - @auth0/auth0-angular - - - - -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    Preparing search index...
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    - -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    - -
                                                                                                                                                                    - - -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    - - +@auth0/auth0-angular
                                                                                                                                                                    +
                                                                                                                                                                    @auth0/auth0-angular + +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      Preparing search index...
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      diff --git a/docs/index.html b/docs/index.html index 300286b5..46582694 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,4 +1,14 @@ -@auth0/auth0-angular
                                                                                                                                                                      @auth0/auth0-angular
                                                                                                                                                                        Preparing search index...

                                                                                                                                                                        @auth0/auth0-angular

                                                                                                                                                                        Auth0 SDK for Angular Single Page Applications

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

                                                                                                                                                                          @auth0/auth0-angular

                                                                                                                                                                          +

                                                                                                                                                                          Auth0 SDK for Angular Single Page Applications

                                                                                                                                                                          A library for integrating Auth0 into an Angular application.

                                                                                                                                                                          Release Codecov @@ -113,4 +123,38 @@

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

                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          diff --git a/docs/interfaces/AppState.html b/docs/interfaces/AppState.html index 9f0f4214..13980bcf 100644 --- a/docs/interfaces/AppState.html +++ b/docs/interfaces/AppState.html @@ -1,551 +1,85 @@ - - - - - - AppState | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                          -
                                                                                                                                                                          - @auth0/auth0-angular - - - - -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            Preparing search index...
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - -

                                                                                                                                                                            Interface AppState

                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -

                                                                                                                                                                            - Angular specific state to be stored before redirect and any - account that the user may have connected to. -

                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - interface - AppState - {
                                                                                                                                                                                connectedAccount?: - ConnectedAccount;
                                                                                                                                                                                response_type?: - ResponseType;
                                                                                                                                                                                target?: - string;
                                                                                                                                                                                [key: - string]: - any;
                                                                                                                                                                            } -
                                                                                                                                                                            -
                                                                                                                                                                            -

                                                                                                                                                                            Indexable

                                                                                                                                                                            -
                                                                                                                                                                              -
                                                                                                                                                                            • -
                                                                                                                                                                              - [key: - string]: - any -
                                                                                                                                                                              -
                                                                                                                                                                              -

                                                                                                                                                                              Any custom parameter to be stored in appState

                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                            • -
                                                                                                                                                                            -
                                                                                                                                                                            - -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - -
                                                                                                                                                                            Index
                                                                                                                                                                            -
                                                                                                                                                                            - -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - -

                                                                                                                                                                            Properties

                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - -
                                                                                                                                                                            - connectedAccount?: - ConnectedAccount -
                                                                                                                                                                            -
                                                                                                                                                                            -

                                                                                                                                                                            - The connected account information when the user has completed - a connect account flow. -

                                                                                                                                                                            -
                                                                                                                                                                            - -
                                                                                                                                                                            -
                                                                                                                                                                            - -
                                                                                                                                                                            - response_type?: - ResponseType -
                                                                                                                                                                            -
                                                                                                                                                                            -

                                                                                                                                                                            - The response type returned from the authentication server. -

                                                                                                                                                                            -
                                                                                                                                                                            - -
                                                                                                                                                                            -
                                                                                                                                                                            - -
                                                                                                                                                                            - target?: - string -
                                                                                                                                                                            -
                                                                                                                                                                            -

                                                                                                                                                                            - Target path the app gets routed to after handling the callback - from Auth0 (defaults to '/') -

                                                                                                                                                                            -
                                                                                                                                                                            - -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - +AppState | @auth0/auth0-angular
                                                                                                                                                                            +
                                                                                                                                                                            @auth0/auth0-angular + +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Preparing search index...
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              + +

                                                                                                                                                                              Interface AppState

                                                                                                                                                                              +
                                                                                                                                                                              +

                                                                                                                                                                              Angular specific state to be stored before redirect +and any account that the user may have connected to.

                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              interface AppState {
                                                                                                                                                                                  connectedAccount?: ConnectedAccount;
                                                                                                                                                                                  response_type?: ResponseType;
                                                                                                                                                                                  target?: string;
                                                                                                                                                                                  [key: string]: any;
                                                                                                                                                                              }
                                                                                                                                                                              +
                                                                                                                                                                              +

                                                                                                                                                                              Indexable

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

                                                                                                                                                                                Any custom parameter to be stored in appState

                                                                                                                                                                                +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Index
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              + +
                                                                                                                                                                              +
                                                                                                                                                                              + +
                                                                                                                                                                              connectedAccount?: ConnectedAccount
                                                                                                                                                                              +

                                                                                                                                                                              The connected account information when the user has completed +a connect account flow.

                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              + +
                                                                                                                                                                              response_type?: ResponseType
                                                                                                                                                                              +

                                                                                                                                                                              The response type returned from the authentication server.

                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              + +
                                                                                                                                                                              target?: string
                                                                                                                                                                              +

                                                                                                                                                                              Target path the app gets routed to after +handling the callback from Auth0 (defaults to '/')

                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              + +
                                                                                                                                                                              +
                                                                                                                                                                              diff --git a/docs/interfaces/AuthConfig.html b/docs/interfaces/AuthConfig.html index 5ec97dd3..6873299e 100644 --- a/docs/interfaces/AuthConfig.html +++ b/docs/interfaces/AuthConfig.html @@ -1,2279 +1,404 @@ - - - - - - AuthConfig | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - @auth0/auth0-angular - - - - -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                - -

                                                                                                                                                                                Interface AuthConfig

                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -

                                                                                                                                                                                Configuration for the authentication service

                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                - interface - AuthConfig - {
                                                                                                                                                                                    auth0Client?: - {
                                                                                                                                                                                        env?: - { - [key: - string]: - string - };
                                                                                                                                                                                        name: - string;
                                                                                                                                                                                        version: - string;
                                                                                                                                                                                    };
                                                                                                                                                                                    authorizationParams?: - ClientAuthorizationParams;
                                                                                                                                                                                    authorizeTimeoutInSeconds?: - number;
                                                                                                                                                                                    cache?: - ICache;
                                                                                                                                                                                    cacheLocation?: - CacheLocation;
                                                                                                                                                                                    clientId: - string;
                                                                                                                                                                                    cookieDomain?: - string;
                                                                                                                                                                                    domain: - string;
                                                                                                                                                                                    errorPath?: - string;
                                                                                                                                                                                    httpInterceptor?: - HttpInterceptorConfig;
                                                                                                                                                                                    httpTimeoutInSeconds?: - number;
                                                                                                                                                                                    interactiveErrorHandler?: - "popup";
                                                                                                                                                                                    issuer?: - string;
                                                                                                                                                                                    leeway?: - number;
                                                                                                                                                                                    legacySameSiteCookie?: - boolean;
                                                                                                                                                                                    nowProvider?: - () - => - number - | - Promise<number>;
                                                                                                                                                                                    sessionCheckExpiryDays?: - number;
                                                                                                                                                                                    sessionTransferTokenQueryParamName?: - string;
                                                                                                                                                                                    skipRedirectCallback?: - boolean;
                                                                                                                                                                                    useCookiesForTransactions?: - boolean;
                                                                                                                                                                                    useDpop?: - boolean;
                                                                                                                                                                                    useFormData?: - boolean;
                                                                                                                                                                                    useMrrt?: - boolean;
                                                                                                                                                                                    useRefreshTokens?: - boolean;
                                                                                                                                                                                    useRefreshTokensFallback?: - boolean;
                                                                                                                                                                                    workerUrl?: - string;
                                                                                                                                                                                } -
                                                                                                                                                                                -
                                                                                                                                                                                -

                                                                                                                                                                                Hierarchy

                                                                                                                                                                                -
                                                                                                                                                                                  -
                                                                                                                                                                                • - Auth0ClientOptions -
                                                                                                                                                                                    -
                                                                                                                                                                                  • - AuthConfig -
                                                                                                                                                                                  • -
                                                                                                                                                                                  -
                                                                                                                                                                                • -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                - - -
                                                                                                                                                                                Index
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                - - -

                                                                                                                                                                                Properties

                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                - auth0Client?: - { - env?: - { - [key: - string]: - string - }; - name: - string; - version: - string - } -
                                                                                                                                                                                -
                                                                                                                                                                                -

                                                                                                                                                                                - Internal property to send information about the client to the - authorization server. -

                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                - authorizationParams?: - ClientAuthorizationParams -
                                                                                                                                                                                -
                                                                                                                                                                                -

                                                                                                                                                                                - 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. -

                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                - authorizeTimeoutInSeconds?: - number -
                                                                                                                                                                                -
                                                                                                                                                                                -

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

                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                - cache?: - ICache -
                                                                                                                                                                                -
                                                                                                                                                                                -

                                                                                                                                                                                - Specify a custom cache implementation to use for token storage - and retrieval. This setting takes precedence over - cacheLocation if they are both specified. -

                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                - cacheLocation?: - CacheLocation -
                                                                                                                                                                                -
                                                                                                                                                                                -

                                                                                                                                                                                - The location to use when storing cache data. Valid values are - memory or localstorage. The default - setting is memory. -

                                                                                                                                                                                -

                                                                                                                                                                                - Read more about - changing storage options in the Auth0 docs -

                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                - clientId: - string -
                                                                                                                                                                                -
                                                                                                                                                                                -

                                                                                                                                                                                The Client ID found on your Application settings page

                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                - cookieDomain?: - string -
                                                                                                                                                                                -
                                                                                                                                                                                -

                                                                                                                                                                                - The domain the cookie is accessible from. If not set, the - cookie is scoped to the current domain, including the - subdomain. -

                                                                                                                                                                                -

                                                                                                                                                                                - Note: setting this incorrectly may cause silent authentication - to stop working on page load. -

                                                                                                                                                                                -

                                                                                                                                                                                - To keep a user logged in across multiple subdomains set this - to your top-level domain and prefixed with a - . (eg: .example.com). -

                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                - domain: - string -
                                                                                                                                                                                -
                                                                                                                                                                                -

                                                                                                                                                                                - Your Auth0 account domain such as - 'example.auth0.com', - 'example.eu.auth0.com' or , - 'example.mycompany.com' (when using - custom domains) -

                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                - errorPath?: - string -
                                                                                                                                                                                -
                                                                                                                                                                                -

                                                                                                                                                                                - Path in your application to redirect to when the Authorization - server returns an error. Defaults to / -

                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                - httpInterceptor?: - HttpInterceptorConfig -
                                                                                                                                                                                -
                                                                                                                                                                                -

                                                                                                                                                                                - Configuration for the built-in Http Interceptor, used for - automatically attaching access tokens. -

                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                - httpTimeoutInSeconds?: - number -
                                                                                                                                                                                -
                                                                                                                                                                                -

                                                                                                                                                                                - Specify the timeout for HTTP calls using fetch. - The default is 10 seconds. -

                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                - interactiveErrorHandler?: - "popup" -
                                                                                                                                                                                -
                                                                                                                                                                                -

                                                                                                                                                                                - Configures automatic handling of interactive authentication - errors. -

                                                                                                                                                                                -

                                                                                                                                                                                - When set, the SDK intercepts mfa_required errors - from getTokenSilently() and handles them - automatically instead of throwing to the caller. -

                                                                                                                                                                                -
                                                                                                                                                                                  -
                                                                                                                                                                                • - 'popup': Opens Universal Login in a popup to - complete MFA. The original - authorizationParams (audience, scope) are - preserved. On success, the token is returned. On failure, - popup errors are thrown. -
                                                                                                                                                                                • -
                                                                                                                                                                                -

                                                                                                                                                                                - This option only affects getTokenSilently(). - Other methods are not affected. -

                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                -
                                                                                                                                                                                - -
                                                                                                                                                                                undefined (MFA errors are thrown to the caller)
                                                                                                                                                                                +AuthConfig | @auth0/auth0-angular
                                                                                                                                                                                +
                                                                                                                                                                                @auth0/auth0-angular + +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  + +

                                                                                                                                                                                  Interface AuthConfig

                                                                                                                                                                                  +
                                                                                                                                                                                  +

                                                                                                                                                                                  Configuration for the authentication service

                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  interface AuthConfig {
                                                                                                                                                                                      auth0Client?: {
                                                                                                                                                                                          env?: { [key: string]: string };
                                                                                                                                                                                          name: string;
                                                                                                                                                                                          version: string;
                                                                                                                                                                                      };
                                                                                                                                                                                      authorizationParams?: ClientAuthorizationParams;
                                                                                                                                                                                      authorizeTimeoutInSeconds?: number;
                                                                                                                                                                                      cache?: ICache;
                                                                                                                                                                                      cacheLocation?: CacheLocation;
                                                                                                                                                                                      clientId: string;
                                                                                                                                                                                      cookieDomain?: string;
                                                                                                                                                                                      domain: string;
                                                                                                                                                                                      errorPath?: string;
                                                                                                                                                                                      httpInterceptor?: HttpInterceptorConfig;
                                                                                                                                                                                      httpTimeoutInSeconds?: number;
                                                                                                                                                                                      interactiveErrorHandler?: "popup";
                                                                                                                                                                                      issuer?: string;
                                                                                                                                                                                      leeway?: number;
                                                                                                                                                                                      legacySameSiteCookie?: boolean;
                                                                                                                                                                                      nowProvider?: () => number | Promise<number>;
                                                                                                                                                                                      refreshTokenMode?: RefreshTokenMode;
                                                                                                                                                                                      sessionCheckExpiryDays?: number;
                                                                                                                                                                                      sessionTransferTokenQueryParamName?: string;
                                                                                                                                                                                      skipRedirectCallback?: boolean;
                                                                                                                                                                                      useCookiesForTransactions?: boolean;
                                                                                                                                                                                      useDpop?: boolean;
                                                                                                                                                                                      useFormData?: boolean;
                                                                                                                                                                                      useMrrt?: boolean;
                                                                                                                                                                                      useRefreshTokens?: boolean;
                                                                                                                                                                                      useRefreshTokensFallback?: boolean;
                                                                                                                                                                                      workerUrl?: string;
                                                                                                                                                                                  }
                                                                                                                                                                                  +
                                                                                                                                                                                  +

                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                  +
                                                                                                                                                                                    +
                                                                                                                                                                                  • Auth0ClientOptions +
                                                                                                                                                                                      +
                                                                                                                                                                                    • AuthConfig
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  Index
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  auth0Client?: { env?: { [key: string]: string }; name: string; version: string }
                                                                                                                                                                                  +

                                                                                                                                                                                  Internal property to send information about the client to the authorization server.

                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  authorizationParams?: ClientAuthorizationParams
                                                                                                                                                                                  +

                                                                                                                                                                                  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.

                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  authorizeTimeoutInSeconds?: number
                                                                                                                                                                                  +

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

                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  cache?: ICache
                                                                                                                                                                                  +

                                                                                                                                                                                  Specify a custom cache implementation to use for token storage and retrieval. This setting takes precedence over cacheLocation if they are both specified.

                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  cacheLocation?: CacheLocation
                                                                                                                                                                                  +

                                                                                                                                                                                  The location to use when storing cache data. Valid values are memory or localstorage. +The default setting is memory.

                                                                                                                                                                                  +

                                                                                                                                                                                  Read more about changing storage options in the Auth0 docs

                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  clientId: string
                                                                                                                                                                                  +

                                                                                                                                                                                  The Client ID found on your Application settings page

                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  cookieDomain?: string
                                                                                                                                                                                  +

                                                                                                                                                                                  The domain the cookie is accessible from. If not set, the cookie is scoped to +the current domain, including the subdomain.

                                                                                                                                                                                  +

                                                                                                                                                                                  Note: setting this incorrectly may cause silent authentication to stop working +on page load.

                                                                                                                                                                                  +

                                                                                                                                                                                  To keep a user logged in across multiple subdomains set this to your +top-level domain and prefixed with a . (eg: .example.com).

                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  domain: string
                                                                                                                                                                                  +

                                                                                                                                                                                  Your Auth0 account domain such as 'example.auth0.com', +'example.eu.auth0.com' or , 'example.mycompany.com' +(when using custom domains)

                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  errorPath?: string
                                                                                                                                                                                  +

                                                                                                                                                                                  Path in your application to redirect to when the Authorization server +returns an error. Defaults to /

                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  httpInterceptor?: HttpInterceptorConfig
                                                                                                                                                                                  +

                                                                                                                                                                                  Configuration for the built-in Http Interceptor, used for +automatically attaching access tokens.

                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  httpTimeoutInSeconds?: number
                                                                                                                                                                                  +

                                                                                                                                                                                  Specify the timeout for HTTP calls using fetch. The default is 10 seconds.

                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  interactiveErrorHandler?: "popup"
                                                                                                                                                                                  +

                                                                                                                                                                                  Configures automatic handling of interactive authentication errors.

                                                                                                                                                                                  +

                                                                                                                                                                                  When set, the SDK intercepts mfa_required errors from getTokenSilently() +and handles them automatically instead of throwing to the caller.

                                                                                                                                                                                  +
                                                                                                                                                                                    +
                                                                                                                                                                                  • 'popup': Opens Universal Login in a popup to complete MFA. +The original authorizationParams (audience, scope) are preserved. +On success, the token is returned. On failure, popup errors are thrown.
                                                                                                                                                                                  • +
                                                                                                                                                                                  +

                                                                                                                                                                                  This option only affects getTokenSilently(). Other methods are not affected.

                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  undefined (MFA errors are thrown to the caller)
                                                                                                                                                                                   
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  - issuer?: - string -
                                                                                                                                                                                  -
                                                                                                                                                                                  -

                                                                                                                                                                                  - The issuer to be used for validation of JWTs, optionally - defaults to the domain above -

                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  - leeway?: - number -
                                                                                                                                                                                  -
                                                                                                                                                                                  -

                                                                                                                                                                                  - The value in seconds used to account for clock skew in JWT - expirations. Typically, this value is no more than a minute or - two at maximum. Defaults to 60s. -

                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  - legacySameSiteCookie?: - boolean -
                                                                                                                                                                                  -
                                                                                                                                                                                  -

                                                                                                                                                                                  - Sets an additional cookie with no SameSite attribute to - support legacy browsers that are not compatible with the - latest SameSite changes. This will log a warning on modern - browsers, you can disable the warning by setting this to false - but be aware that some older useragents will not work, See - https://www.chromium.org/updates/same-site/incompatible-clients - Defaults to true -

                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  - nowProvider?: - () - => - number - | - Promise<number> -
                                                                                                                                                                                  -
                                                                                                                                                                                  -

                                                                                                                                                                                  - Modify the value used as the current time during the token - validation. -

                                                                                                                                                                                  -

                                                                                                                                                                                  - Note: Using this improperly can potentially - compromise the token validation. -

                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  - sessionCheckExpiryDays?: - number -
                                                                                                                                                                                  -
                                                                                                                                                                                  -

                                                                                                                                                                                  - Number of days until the cookie - auth0.is.authenticated will expire Defaults to 1. -

                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  - sessionTransferTokenQueryParamName?: - string -
                                                                                                                                                                                  -
                                                                                                                                                                                  -

                                                                                                                                                                                  - Query parameter name to extract the session transfer token - from for Native to Web SSO. -

                                                                                                                                                                                  -

                                                                                                                                                                                  - When set, the SDK automatically extracts the token from the - specified URL query parameter and includes it as - session_transfer_token in authorization requests. - This enables seamless single sign-on when users transition - from a native mobile application to a web application. -

                                                                                                                                                                                  -

                                                                                                                                                                                  - After extraction, the token is automatically removed from the - URL using window.history.replaceState() to - prevent accidental reuse on subsequent authentication - requests. -

                                                                                                                                                                                  -

                                                                                                                                                                                  - Default: undefined (feature - disabled) -

                                                                                                                                                                                  -

                                                                                                                                                                                  Common values:

                                                                                                                                                                                  -
                                                                                                                                                                                    -
                                                                                                                                                                                  • - 'session_transfer_token' - Standard parameter - name -
                                                                                                                                                                                  • -
                                                                                                                                                                                  • 'stt' - Shortened version
                                                                                                                                                                                  • -
                                                                                                                                                                                  • Custom parameter name of your choice
                                                                                                                                                                                  • -
                                                                                                                                                                                  -

                                                                                                                                                                                  - Set to undefined to disable automatic extraction - if you prefer to handle session transfer tokens manually. -

                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  const auth0 = await createAuth0Client({
                                                                                                                                                                                  domain: '<AUTH0_DOMAIN>',
                                                                                                                                                                                  clientId: '<AUTH0_CLIENT_ID>',
                                                                                                                                                                                  sessionTransferTokenQueryParamName: 'session_transfer_token'
                                                                                                                                                                                  }); + +
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  issuer?: string
                                                                                                                                                                                  +

                                                                                                                                                                                  The issuer to be used for validation of JWTs, optionally defaults to the domain above

                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  leeway?: number
                                                                                                                                                                                  +

                                                                                                                                                                                  The value in seconds used to account for clock skew in JWT expirations. +Typically, this value is no more than a minute or two at maximum. +Defaults to 60s.

                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  legacySameSiteCookie?: boolean
                                                                                                                                                                                  +

                                                                                                                                                                                  Sets an additional cookie with no SameSite attribute to support legacy browsers +that are not compatible with the latest SameSite changes. +This will log a warning on modern browsers, you can disable the warning by setting +this to false but be aware that some older useragents will not work, +See https://www.chromium.org/updates/same-site/incompatible-clients +Defaults to true

                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  nowProvider?: () => number | Promise<number>
                                                                                                                                                                                  +

                                                                                                                                                                                  Modify the value used as the current time during the token validation.

                                                                                                                                                                                  +

                                                                                                                                                                                  Note: Using this improperly can potentially compromise the token validation.

                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  refreshTokenMode?: RefreshTokenMode
                                                                                                                                                                                  +

                                                                                                                                                                                  Selects the refresh-token variant used when useRefreshTokens: true. +Defaults to RefreshTokenMode.Offline.

                                                                                                                                                                                  + +

                                                                                                                                                                                  Online mode requires useRefreshTokens: true and useDpop: true. The +online_access and offline_access scopes are mutually exclusive.

                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  sessionCheckExpiryDays?: number
                                                                                                                                                                                  +

                                                                                                                                                                                  Number of days until the cookie auth0.is.authenticated will expire +Defaults to 1.

                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  sessionTransferTokenQueryParamName?: string
                                                                                                                                                                                  +

                                                                                                                                                                                  Query parameter name to extract the session transfer token from for Native to Web SSO.

                                                                                                                                                                                  +

                                                                                                                                                                                  When set, the SDK automatically extracts the token from the specified URL query +parameter and includes it as session_transfer_token in authorization requests. +This enables seamless single sign-on when users transition from a native mobile +application to a web application.

                                                                                                                                                                                  +

                                                                                                                                                                                  After extraction, the token is automatically removed from the URL using +window.history.replaceState() to prevent accidental reuse on subsequent +authentication requests.

                                                                                                                                                                                  +

                                                                                                                                                                                  Default: undefined (feature disabled)

                                                                                                                                                                                  +

                                                                                                                                                                                  Common values:

                                                                                                                                                                                  +
                                                                                                                                                                                    +
                                                                                                                                                                                  • 'session_transfer_token' - Standard parameter name
                                                                                                                                                                                  • +
                                                                                                                                                                                  • 'stt' - Shortened version
                                                                                                                                                                                  • +
                                                                                                                                                                                  • Custom parameter name of your choice
                                                                                                                                                                                  • +
                                                                                                                                                                                  +

                                                                                                                                                                                  Set to undefined to disable automatic extraction if you prefer to handle +session transfer tokens manually.

                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  const auth0 = await createAuth0Client({
                                                                                                                                                                                  domain: '<AUTH0_DOMAIN>',
                                                                                                                                                                                  clientId: '<AUTH0_CLIENT_ID>',
                                                                                                                                                                                  sessionTransferTokenQueryParamName: 'session_transfer_token'
                                                                                                                                                                                  });
                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  - -
                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  - skipRedirectCallback?: - boolean -
                                                                                                                                                                                  -
                                                                                                                                                                                  -

                                                                                                                                                                                  - By default, if the page URL has code and state parameters, the - SDK will assume they are for an Auth0 application and attempt - to exchange the code for a token. In some cases the code might - be for something else (e.g. another OAuth SDK). In these - instances you can instruct the client to ignore them by - setting skipRedirectCallback. -

                                                                                                                                                                                  -
                                                                                                                                                                                  AuthModule.forRoot({
                                                                                                                                                                                  skipRedirectCallback: window.location.pathname === '/other-callback'
                                                                                                                                                                                  }) + +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  skipRedirectCallback?: boolean
                                                                                                                                                                                  +

                                                                                                                                                                                  By default, if the page URL has code and state parameters, the SDK will assume they are for +an Auth0 application and attempt to exchange the code for a token. +In some cases the code might be for something else (e.g. another OAuth SDK). In these +instances you can instruct the client to ignore them by setting skipRedirectCallback.

                                                                                                                                                                                  +
                                                                                                                                                                                  AuthModule.forRoot({
                                                                                                                                                                                  skipRedirectCallback: window.location.pathname === '/other-callback'
                                                                                                                                                                                  })
                                                                                                                                                                                  -

                                                                                                                                                                                  - Note: In the above example, - /other-callback is an existing route that will be - called by any other OAuth provider with a - code (or error in case when - something went wrong) and state. -

                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  - useCookiesForTransactions?: - boolean -
                                                                                                                                                                                  -
                                                                                                                                                                                  -

                                                                                                                                                                                  - If true, the SDK will use a cookie when storing - information about the auth transaction while the user is going - through the authentication flow on the authorization server. -

                                                                                                                                                                                  -

                                                                                                                                                                                  - The default is false, in which case the SDK will - use session storage. -

                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  - -

                                                                                                                                                                                  - You might want to enable this if you rely on your users - being able to authenticate using flows that may end up - spanning across multiple tabs (e.g. magic links) or you - cannot otherwise rely on session storage being available. -

                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  - useDpop?: - boolean -
                                                                                                                                                                                  -
                                                                                                                                                                                  -

                                                                                                                                                                                  - If true, DPoP (OAuth 2.0 Demonstrating Proof of - Possession, RFC9449) will be used to cryptographically bind - tokens to this specific browser so they can't be used from a - different device in case of a leak. -

                                                                                                                                                                                  -

                                                                                                                                                                                  The default setting is false.

                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  - useFormData?: - boolean -
                                                                                                                                                                                  -
                                                                                                                                                                                  -

                                                                                                                                                                                  - If true, data to the token endpoint is transmitted as - x-www-form-urlencoded data, if false it will be transmitted as - JSON. The default setting is true. -

                                                                                                                                                                                  -

                                                                                                                                                                                  - Note: Setting this to false may - affect you if you use Auth0 Rules and are sending custom, - non-primitive data. If you disable this, please verify that - your Auth0 Rules continue to work as intended. -

                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  - useMrrt?: - boolean -
                                                                                                                                                                                  -
                                                                                                                                                                                  -

                                                                                                                                                                                  - If true, the SDK will allow the refreshing of - tokens using MRRT -

                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  - useRefreshTokens?: - boolean -
                                                                                                                                                                                  -
                                                                                                                                                                                  -

                                                                                                                                                                                  - If true, refresh tokens are used to fetch new access tokens - from the Auth0 server. If false, the standard technique of - using a hidden iframe and the - authorization_code grant with - prompt=none is used. The default setting is - false. -

                                                                                                                                                                                  -

                                                                                                                                                                                  - Standard technique relies on cookies. Because browsers - increasingly block third-party cookies, it requires a Custom - Domain to function reliably. Refresh tokens serve as a - fallback for environments where third-party cookies are - blocked. Using a Custom Domain with this set to - false is the most secure and recommended - approach. -

                                                                                                                                                                                  -

                                                                                                                                                                                  - Note: Use of refresh tokens must be enabled - by an administrator on your Auth0 client application. -

                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  - useRefreshTokensFallback?: - boolean -
                                                                                                                                                                                  -
                                                                                                                                                                                  -

                                                                                                                                                                                  - If true, fallback to the technique of using a hidden iframe - and the authorization_code grant with - prompt=none when unable to use refresh tokens. If - false, the iframe fallback is not used and errors relating to - a failed refresh_token grant should be handled - appropriately. The default setting is false. -

                                                                                                                                                                                  -

                                                                                                                                                                                  - Note: There might be situations where doing - silent auth with a Web Message response from an iframe is not - possible, like when you're serving your application from the - file system or a custom protocol (like in a Desktop or Native - app). In situations like this you can disable the iframe - fallback and handle the failed - refresh_token grant and prompt the user to login - interactively with loginWithRedirect or - loginWithPopup." -

                                                                                                                                                                                  -

                                                                                                                                                                                  - E.g. Using the file: protocol in an Electron - application does not support that legacy technique. -

                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  let token: string;
                                                                                                                                                                                  try {
                                                                                                                                                                                  token = await auth0.getTokenSilently();
                                                                                                                                                                                  } catch (e) {
                                                                                                                                                                                  if (e.error === 'missing_refresh_token' || e.error === 'invalid_grant') {
                                                                                                                                                                                  auth0.loginWithRedirect();
                                                                                                                                                                                  }
                                                                                                                                                                                  } +

                                                                                                                                                                                  Note: In the above example, /other-callback is an existing route that will be called +by any other OAuth provider with a code (or error in case when something went wrong) and state.

                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  useCookiesForTransactions?: boolean
                                                                                                                                                                                  +

                                                                                                                                                                                  If true, the SDK will use a cookie when storing information about the auth transaction while +the user is going through the authentication flow on the authorization server.

                                                                                                                                                                                  +

                                                                                                                                                                                  The default is false, in which case the SDK will use session storage.

                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  +

                                                                                                                                                                                  You might want to enable this if you rely on your users being able to authenticate using flows that +may end up spanning across multiple tabs (e.g. magic links) or you cannot otherwise rely on session storage being available.

                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  useDpop?: boolean
                                                                                                                                                                                  +

                                                                                                                                                                                  If true, DPoP (OAuth 2.0 Demonstrating Proof of Possession, RFC9449) +will be used to cryptographically bind tokens to this specific browser +so they can't be used from a different device in case of a leak.

                                                                                                                                                                                  +

                                                                                                                                                                                  The default setting is false.

                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  useFormData?: boolean
                                                                                                                                                                                  +

                                                                                                                                                                                  If true, data to the token endpoint is transmitted as x-www-form-urlencoded data, if false it will be transmitted as JSON. The default setting is true.

                                                                                                                                                                                  +

                                                                                                                                                                                  Note: Setting this to false may affect you if you use Auth0 Rules and are sending custom, non-primitive data. If you disable this, +please verify that your Auth0 Rules continue to work as intended.

                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  useMrrt?: boolean
                                                                                                                                                                                  +

                                                                                                                                                                                  If true, the SDK will allow the refreshing of tokens using MRRT

                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  useRefreshTokens?: boolean
                                                                                                                                                                                  +

                                                                                                                                                                                  If true, refresh tokens are used to fetch new access tokens from the Auth0 server. If false, the standard technique of using a hidden iframe and the authorization_code grant with prompt=none is used. +The default setting is false.

                                                                                                                                                                                  +

                                                                                                                                                                                  Standard technique relies on cookies. Because browsers increasingly block third-party cookies, it requires a Custom Domain to function reliably. Refresh tokens serve as a fallback for environments where third-party cookies are blocked. +Using a Custom Domain with this set to false is the most secure and recommended approach.

                                                                                                                                                                                  +

                                                                                                                                                                                  Note: Use of refresh tokens must be enabled by an administrator on your Auth0 client application.

                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  useRefreshTokensFallback?: boolean
                                                                                                                                                                                  +

                                                                                                                                                                                  If true, fallback to the technique of using a hidden iframe and the authorization_code grant with prompt=none when unable to use refresh tokens. If false, the iframe fallback is not used and +errors relating to a failed refresh_token grant should be handled appropriately. The default setting is false.

                                                                                                                                                                                  +

                                                                                                                                                                                  Note: There might be situations where doing silent auth with a Web Message response from an iframe is not possible, +like when you're serving your application from the file system or a custom protocol (like in a Desktop or Native app). +In situations like this you can disable the iframe fallback and handle the failed refresh_token grant and prompt the user to login interactively with loginWithRedirect or loginWithPopup."

                                                                                                                                                                                  +

                                                                                                                                                                                  E.g. Using the file: protocol in an Electron application does not support that legacy technique.

                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  let token: string;
                                                                                                                                                                                  try {
                                                                                                                                                                                  token = await auth0.getTokenSilently();
                                                                                                                                                                                  } catch (e) {
                                                                                                                                                                                  if (e.error === 'missing_refresh_token' || e.error === 'invalid_grant') {
                                                                                                                                                                                  auth0.loginWithRedirect();
                                                                                                                                                                                  }
                                                                                                                                                                                  }
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  - workerUrl?: - string -
                                                                                                                                                                                  -
                                                                                                                                                                                  -

                                                                                                                                                                                  - If provided, the SDK will load the token worker from this URL - instead of the integrated blob. An example of - when this is useful is if you have strict - Content-Security-Policy (CSP) and wish to avoid needing to set - worker-src: blob:. We recommend either serving - the worker, which you can find in the module at - <module_path>/dist/auth0-spa-js.worker.production.js, from the same host as your application or using the Auth0 - CDN - https://cdn.auth0.com/js/auth0-spa-js/<version>/auth0-spa-js.worker.production.js. -

                                                                                                                                                                                  -

                                                                                                                                                                                  - Note: The worker is only used when - useRefreshTokens: true, - cacheLocation: 'memory', and the - cache is not custom. -

                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  - - + + +
                                                                                                                                                                                  + +
                                                                                                                                                                                  workerUrl?: string
                                                                                                                                                                                  +

                                                                                                                                                                                  If provided, the SDK will load the token worker from this URL instead of the integrated blob. An example of when this is useful is if you have strict +Content-Security-Policy (CSP) and wish to avoid needing to set worker-src: blob:. We recommend either serving the worker, which you can find in the module +at <module_path>/dist/auth0-spa-js.worker.production.js, from the same host as your application or using the Auth0 CDN +https://cdn.auth0.com/js/auth0-spa-js/<version>/auth0-spa-js.worker.production.js.

                                                                                                                                                                                  +

                                                                                                                                                                                  Note: The worker is only used when useRefreshTokens: true, cacheLocation: 'memory', and the cache is not custom.

                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  diff --git a/docs/interfaces/Authenticator.html b/docs/interfaces/Authenticator.html index 8bec6a3e..31d1b94a 100644 --- a/docs/interfaces/Authenticator.html +++ b/docs/interfaces/Authenticator.html @@ -1,16 +1,107 @@ -Authenticator | @auth0/auth0-angular
                                                                                                                                                                                  @auth0/auth0-angular
                                                                                                                                                                                    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-angular
                                                                                                                                                                                    +
                                                                                                                                                                                    @auth0/auth0-angular + +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      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: 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

                                                                                                                                                                                      -
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      + +
                                                                                                                                                                                      +
                                                                                                                                                                                      + +
                                                                                                                                                                                      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

                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      + +
                                                                                                                                                                                      +
                                                                                                                                                                                      diff --git a/docs/interfaces/AuthorizationParams.html b/docs/interfaces/AuthorizationParams.html index ec8d0c55..be1d0820 100644 --- a/docs/interfaces/AuthorizationParams.html +++ b/docs/interfaces/AuthorizationParams.html @@ -1,6 +1,34 @@ -AuthorizationParams | @auth0/auth0-angular
                                                                                                                                                                                      @auth0/auth0-angular
                                                                                                                                                                                        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-angular

                                                                                                                                                                                          +
                                                                                                                                                                                          @auth0/auth0-angular + +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            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

                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Index
                                                                                                                                                                                          +

                                                                                                                                                                                          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.

                                                                                                                                                                                          -
                                                                                                                                                                                          ui_locales?: string

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

                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          + +
                                                                                                                                                                                          ui_locales?: string
                                                                                                                                                                                          +

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

                                                                                                                                                                                          -
                                                                                                                                                                                          + +
                                                                                                                                                                                          + +
                                                                                                                                                                                          +
                                                                                                                                                                                          diff --git a/docs/interfaces/ChallengeAuthenticatorParams.html b/docs/interfaces/ChallengeAuthenticatorParams.html index cf0226d9..652db22b 100644 --- a/docs/interfaces/ChallengeAuthenticatorParams.html +++ b/docs/interfaces/ChallengeAuthenticatorParams.html @@ -1,8 +1,75 @@ -ChallengeAuthenticatorParams | @auth0/auth0-angular
                                                                                                                                                                                          @auth0/auth0-angular
                                                                                                                                                                                            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-angular
                                                                                                                                                                                            +
                                                                                                                                                                                            @auth0/auth0-angular + +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              + +

                                                                                                                                                                                              Interface ChallengeAuthenticatorParams

                                                                                                                                                                                              +
                                                                                                                                                                                              +

                                                                                                                                                                                              Parameters for initiating an MFA challenge

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

                                                                                                                                                                                              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

                                                                                                                                                                                              -
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              + +
                                                                                                                                                                                              +
                                                                                                                                                                                              + +
                                                                                                                                                                                              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

                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              + +
                                                                                                                                                                                              +
                                                                                                                                                                                              diff --git a/docs/interfaces/ChallengeResponse.html b/docs/interfaces/ChallengeResponse.html index 3e118afe..22e1a9b7 100644 --- a/docs/interfaces/ChallengeResponse.html +++ b/docs/interfaces/ChallengeResponse.html @@ -1,8 +1,75 @@ -ChallengeResponse | @auth0/auth0-angular
                                                                                                                                                                                              @auth0/auth0-angular
                                                                                                                                                                                                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-angular
                                                                                                                                                                                                +
                                                                                                                                                                                                @auth0/auth0-angular + +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + +

                                                                                                                                                                                                  Interface ChallengeResponse

                                                                                                                                                                                                  +
                                                                                                                                                                                                  +

                                                                                                                                                                                                  Response from initiating an MFA challenge

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

                                                                                                                                                                                                  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)

                                                                                                                                                                                                  -
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + +
                                                                                                                                                                                                  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)

                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  diff --git a/docs/interfaces/EmailAuthenticationMethod.html b/docs/interfaces/EmailAuthenticationMethod.html index c7d4d590..ffb9b4a6 100644 --- a/docs/interfaces/EmailAuthenticationMethod.html +++ b/docs/interfaces/EmailAuthenticationMethod.html @@ -1,767 +1,108 @@ - - - - - - EmailAuthenticationMethod | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - -

                                                                                                                                                                                                    Interface EmailAuthenticationMethod

                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - interface - EmailAuthenticationMethod - {
                                                                                                                                                                                                        confirmed: - boolean;
                                                                                                                                                                                                        created_at: - string;
                                                                                                                                                                                                        email: - string;
                                                                                                                                                                                                        id: - string;
                                                                                                                                                                                                        last_auth_at?: - string;
                                                                                                                                                                                                        name?: - string;
                                                                                                                                                                                                        type: - "email";
                                                                                                                                                                                                        usage: ("primary" - | - "secondary")[];
                                                                                                                                                                                                    } -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                    -
                                                                                                                                                                                                      -
                                                                                                                                                                                                    • - AuthenticationMethodWithMetadata -
                                                                                                                                                                                                        -
                                                                                                                                                                                                      • - EmailAuthenticationMethod -
                                                                                                                                                                                                      • -
                                                                                                                                                                                                      -
                                                                                                                                                                                                    • -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - -
                                                                                                                                                                                                    Index
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - -

                                                                                                                                                                                                    Properties

                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - -
                                                                                                                                                                                                    - confirmed: - boolean -
                                                                                                                                                                                                    - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - -
                                                                                                                                                                                                    - created_at: - string -
                                                                                                                                                                                                    - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - -
                                                                                                                                                                                                    - email: - string -
                                                                                                                                                                                                    - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - -
                                                                                                                                                                                                    - id: - string -
                                                                                                                                                                                                    - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - -
                                                                                                                                                                                                    - last_auth_at?: - string -
                                                                                                                                                                                                    - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - -
                                                                                                                                                                                                    - name?: - string -
                                                                                                                                                                                                    - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - -
                                                                                                                                                                                                    - type: - "email" -
                                                                                                                                                                                                    - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - -
                                                                                                                                                                                                    - usage: ("primary" - | - "secondary")[] -
                                                                                                                                                                                                    - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - +EmailAuthenticationMethod | @auth0/auth0-angular
                                                                                                                                                                                                    +
                                                                                                                                                                                                    @auth0/auth0-angular + +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + +

                                                                                                                                                                                                      Interface EmailAuthenticationMethod

                                                                                                                                                                                                      +
                                                                                                                                                                                                      interface EmailAuthenticationMethod {
                                                                                                                                                                                                          confirmed: boolean;
                                                                                                                                                                                                          created_at: string;
                                                                                                                                                                                                          email: string;
                                                                                                                                                                                                          id: string;
                                                                                                                                                                                                          last_auth_at?: string;
                                                                                                                                                                                                          name?: string;
                                                                                                                                                                                                          type: "email";
                                                                                                                                                                                                          usage: ("primary" | "secondary")[];
                                                                                                                                                                                                      }
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +

                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                      +
                                                                                                                                                                                                        +
                                                                                                                                                                                                      • AuthenticationMethodWithMetadata +
                                                                                                                                                                                                          +
                                                                                                                                                                                                        • EmailAuthenticationMethod
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Index
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + +
                                                                                                                                                                                                      confirmed: boolean
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + +
                                                                                                                                                                                                      created_at: string
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + +
                                                                                                                                                                                                      email: string
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + +
                                                                                                                                                                                                      id: string
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + +
                                                                                                                                                                                                      last_auth_at?: string
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + +
                                                                                                                                                                                                      name?: string
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + +
                                                                                                                                                                                                      type: "email"
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + +
                                                                                                                                                                                                      usage: ("primary" | "secondary")[]
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      diff --git a/docs/interfaces/EmailEnrollmentChallengeOptions.html b/docs/interfaces/EmailEnrollmentChallengeOptions.html index 721d9671..e1ddfe18 100644 --- a/docs/interfaces/EmailEnrollmentChallengeOptions.html +++ b/docs/interfaces/EmailEnrollmentChallengeOptions.html @@ -1,3 +1,60 @@ -EmailEnrollmentChallengeOptions | @auth0/auth0-angular
                                                                                                                                                                                                      @auth0/auth0-angular
                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                        Interface EmailEnrollmentChallengeOptions

                                                                                                                                                                                                        interface EmailEnrollmentChallengeOptions {
                                                                                                                                                                                                            email: string;
                                                                                                                                                                                                            type: "email";
                                                                                                                                                                                                        }
                                                                                                                                                                                                        Index

                                                                                                                                                                                                        Properties

                                                                                                                                                                                                        email +EmailEnrollmentChallengeOptions | @auth0/auth0-angular
                                                                                                                                                                                                        +
                                                                                                                                                                                                        @auth0/auth0-angular + +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + +

                                                                                                                                                                                                          Interface EmailEnrollmentChallengeOptions

                                                                                                                                                                                                          +
                                                                                                                                                                                                          interface EmailEnrollmentChallengeOptions {
                                                                                                                                                                                                              email: string;
                                                                                                                                                                                                              type: "email";
                                                                                                                                                                                                          }
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Index
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + +

                                                                                                                                                                                                          Properties

                                                                                                                                                                                                          email: string
                                                                                                                                                                                                          type: "email"
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + +
                                                                                                                                                                                                          email: string
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + +
                                                                                                                                                                                                          type: "email"
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          diff --git a/docs/interfaces/EmailEnrollmentChallengeResponse.html b/docs/interfaces/EmailEnrollmentChallengeResponse.html index cfc00917..192aa709 100644 --- a/docs/interfaces/EmailEnrollmentChallengeResponse.html +++ b/docs/interfaces/EmailEnrollmentChallengeResponse.html @@ -1,557 +1,81 @@ - - - - - - EmailEnrollmentChallengeResponse | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - -

                                                                                                                                                                                                            Interface EmailEnrollmentChallengeResponse

                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - interface - EmailEnrollmentChallengeResponse - {
                                                                                                                                                                                                                auth_session: - string;
                                                                                                                                                                                                                id: - string;
                                                                                                                                                                                                                location: - string;
                                                                                                                                                                                                                type: - "email";
                                                                                                                                                                                                            } -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -

                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                            -
                                                                                                                                                                                                              -
                                                                                                                                                                                                            • - EnrollmentChallengeBaseResponse -
                                                                                                                                                                                                                -
                                                                                                                                                                                                              • - EmailEnrollmentChallengeResponse -
                                                                                                                                                                                                              • -
                                                                                                                                                                                                              -
                                                                                                                                                                                                            • -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - - -
                                                                                                                                                                                                            Index
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -

                                                                                                                                                                                                            Properties

                                                                                                                                                                                                            - -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - - -

                                                                                                                                                                                                            Properties

                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - -
                                                                                                                                                                                                            - auth_session: - string -
                                                                                                                                                                                                            - -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - -
                                                                                                                                                                                                            - id: - string -
                                                                                                                                                                                                            - -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - -
                                                                                                                                                                                                            - location: - string -
                                                                                                                                                                                                            - -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - -
                                                                                                                                                                                                            - type: - "email" -
                                                                                                                                                                                                            - -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - - -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - - +EmailEnrollmentChallengeResponse | @auth0/auth0-angular
                                                                                                                                                                                                            +
                                                                                                                                                                                                            @auth0/auth0-angular + +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + +

                                                                                                                                                                                                              Interface EmailEnrollmentChallengeResponse

                                                                                                                                                                                                              +
                                                                                                                                                                                                              interface EmailEnrollmentChallengeResponse {
                                                                                                                                                                                                                  auth_session: string;
                                                                                                                                                                                                                  id: string;
                                                                                                                                                                                                                  location: string;
                                                                                                                                                                                                                  type: "email";
                                                                                                                                                                                                              }
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +

                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                              +
                                                                                                                                                                                                                +
                                                                                                                                                                                                              • EnrollmentChallengeBaseResponse +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                • EmailEnrollmentChallengeResponse
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Index
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + +
                                                                                                                                                                                                              auth_session: string
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + +
                                                                                                                                                                                                              id: string
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + +
                                                                                                                                                                                                              location: string
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + +
                                                                                                                                                                                                              type: "email"
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              diff --git a/docs/interfaces/EmailEnrollmentVerifyOptions.html b/docs/interfaces/EmailEnrollmentVerifyOptions.html index c0a3c55b..bc660e1e 100644 --- a/docs/interfaces/EmailEnrollmentVerifyOptions.html +++ b/docs/interfaces/EmailEnrollmentVerifyOptions.html @@ -1,549 +1,80 @@ - - - - - - EmailEnrollmentVerifyOptions | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                - -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                - -

                                                                                                                                                                                                                Interface EmailEnrollmentVerifyOptions

                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                - interface - EmailEnrollmentVerifyOptions - {
                                                                                                                                                                                                                    auth_session: - string;
                                                                                                                                                                                                                    location: - string;
                                                                                                                                                                                                                    otp_code: - string;
                                                                                                                                                                                                                    type: - "email";
                                                                                                                                                                                                                } -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -

                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                • - EnrollmentVerifyBaseOptions -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                  • - EmailEnrollmentVerifyOptions -
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                • -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                - -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                - - -
                                                                                                                                                                                                                Index
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -

                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                - -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                - - -

                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                - -
                                                                                                                                                                                                                - auth_session: - string -
                                                                                                                                                                                                                - -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                - -
                                                                                                                                                                                                                - location: - string -
                                                                                                                                                                                                                - -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                - -
                                                                                                                                                                                                                - otp_code: - string -
                                                                                                                                                                                                                - -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                - -
                                                                                                                                                                                                                - type: - "email" -
                                                                                                                                                                                                                - -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                - - -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                - - +EmailEnrollmentVerifyOptions | @auth0/auth0-angular
                                                                                                                                                                                                                +
                                                                                                                                                                                                                @auth0/auth0-angular + +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                  Interface EmailEnrollmentVerifyOptions

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  interface EmailEnrollmentVerifyOptions {
                                                                                                                                                                                                                      auth_session: string;
                                                                                                                                                                                                                      location: string;
                                                                                                                                                                                                                      otp_code: string;
                                                                                                                                                                                                                      type: "email";
                                                                                                                                                                                                                  }
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                  • EnrollmentVerifyBaseOptions +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                    • EmailEnrollmentVerifyOptions
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  Index
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  auth_session: string
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  location: string
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  otp_code: string
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  type: "email"
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  diff --git a/docs/interfaces/EnrollEmailParams.html b/docs/interfaces/EnrollEmailParams.html index e7aa545c..608dc210 100644 --- a/docs/interfaces/EnrollEmailParams.html +++ b/docs/interfaces/EnrollEmailParams.html @@ -1,504 +1,82 @@ - - - - - - EnrollEmailParams | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                    Interface EnrollEmailParams

                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -

                                                                                                                                                                                                                    Email enrollment parameters

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

                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                    -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                    • - EnrollBaseParams -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                      • - EnrollEmailParams -
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                    Index
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -

                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    - - -

                                                                                                                                                                                                                    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

                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    - - +EnrollEmailParams | @auth0/auth0-angular
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    @auth0/auth0-angular + +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                      Interface EnrollEmailParams

                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +

                                                                                                                                                                                                                      Email enrollment parameters

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

                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                      +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                      • EnrollBaseParams +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                        • EnrollEmailParams
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      Index
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                      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

                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      diff --git a/docs/interfaces/EnrollOtpParams.html b/docs/interfaces/EnrollOtpParams.html index 3a037297..73b39dc6 100644 --- a/docs/interfaces/EnrollOtpParams.html +++ b/docs/interfaces/EnrollOtpParams.html @@ -1,454 +1,74 @@ - - - - - - EnrollOtpParams | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - -

                                                                                                                                                                                                                        Interface EnrollOtpParams

                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -

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

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

                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                        -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                        • - EnrollBaseParams -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                          • - EnrollOtpParams -
                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - - -
                                                                                                                                                                                                                        Index
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -

                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - - -

                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                        - factorType: - "otp" -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -

                                                                                                                                                                                                                        The factor type for enrollment

                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                        - mfaToken: - string -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -

                                                                                                                                                                                                                        MFA token from mfa_required error

                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - - -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - - +EnrollOtpParams | @auth0/auth0-angular
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        @auth0/auth0-angular + +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                          Interface EnrollOtpParams

                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +

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

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

                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                          +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                          • EnrollBaseParams +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                            • EnrollOtpParams
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          Index
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                          factorType: "otp"
                                                                                                                                                                                                                          +

                                                                                                                                                                                                                          The factor type for enrollment

                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                          mfaToken: string
                                                                                                                                                                                                                          +

                                                                                                                                                                                                                          MFA token from mfa_required error

                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          diff --git a/docs/interfaces/EnrollPushParams.html b/docs/interfaces/EnrollPushParams.html index 01600724..10de1502 100644 --- a/docs/interfaces/EnrollPushParams.html +++ b/docs/interfaces/EnrollPushParams.html @@ -1,454 +1,74 @@ - - - - - - EnrollPushParams | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - -

                                                                                                                                                                                                                            Interface EnrollPushParams

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            Push notification enrollment parameters

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

                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                            • - EnrollBaseParams -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                              • - EnrollPushParams -
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - - -
                                                                                                                                                                                                                            Index
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - - -

                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                            - factorType: - "push" -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            The factor type for enrollment

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                            - mfaToken: - string -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            MFA token from mfa_required error

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - - -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - - +EnrollPushParams | @auth0/auth0-angular
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            @auth0/auth0-angular + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                              Interface EnrollPushParams

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              Push notification enrollment parameters

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

                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                              • EnrollBaseParams +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                • EnrollPushParams
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              Index
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                              factorType: "push"
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              The factor type for enrollment

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                              mfaToken: string
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              MFA token from mfa_required error

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              diff --git a/docs/interfaces/EnrollSmsParams.html b/docs/interfaces/EnrollSmsParams.html index d5c4db25..a65477e0 100644 --- a/docs/interfaces/EnrollSmsParams.html +++ b/docs/interfaces/EnrollSmsParams.html @@ -1,507 +1,82 @@ - - - - - - EnrollSmsParams | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - -

                                                                                                                                                                                                                                Interface EnrollSmsParams

                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                SMS enrollment parameters

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

                                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                • - EnrollBaseParams -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • - EnrollSmsParams -
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - - -
                                                                                                                                                                                                                                Index
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - - -

                                                                                                                                                                                                                                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)

                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - - -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - - +EnrollSmsParams | @auth0/auth0-angular
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                @auth0/auth0-angular + +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                  Interface EnrollSmsParams

                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                  SMS enrollment parameters

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

                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                  • EnrollBaseParams +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                    • EnrollSmsParams
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  Index
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                  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)

                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  diff --git a/docs/interfaces/EnrollVoiceParams.html b/docs/interfaces/EnrollVoiceParams.html index d58df611..019dcdc3 100644 --- a/docs/interfaces/EnrollVoiceParams.html +++ b/docs/interfaces/EnrollVoiceParams.html @@ -1,507 +1,82 @@ - - - - - - EnrollVoiceParams | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                    Interface EnrollVoiceParams

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Voice enrollment parameters

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

                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • - EnrollBaseParams -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                      • - EnrollVoiceParams -
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                                    Index
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - - -

                                                                                                                                                                                                                                    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)

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - - +EnrollVoiceParams | @auth0/auth0-angular
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    @auth0/auth0-angular + +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                      Interface EnrollVoiceParams

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      Voice enrollment parameters

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

                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                      • EnrollBaseParams +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                        • EnrollVoiceParams
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      Index
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                      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)

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      diff --git a/docs/interfaces/EnrollmentFactor.html b/docs/interfaces/EnrollmentFactor.html index f00a9153..49845834 100644 --- a/docs/interfaces/EnrollmentFactor.html +++ b/docs/interfaces/EnrollmentFactor.html @@ -1,4 +1,59 @@ -EnrollmentFactor | @auth0/auth0-angular
                                                                                                                                                                                                                                      @auth0/auth0-angular
                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                        Interface EnrollmentFactor

                                                                                                                                                                                                                                        Enrollment factor returned by getEnrollmentFactors

                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        interface EnrollmentFactor {
                                                                                                                                                                                                                                            type: string;
                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                        type: string

                                                                                                                                                                                                                                        Type of enrollment factor available

                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        +EnrollmentFactor | @auth0/auth0-angular
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        @auth0/auth0-angular + +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                          Interface EnrollmentFactor

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                          Enrollment factor returned by getEnrollmentFactors

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

                                                                                                                                                                                                                                          Type of enrollment factor available

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          diff --git a/docs/interfaces/Factor.html b/docs/interfaces/Factor.html index d4a00f3f..31417d08 100644 --- a/docs/interfaces/Factor.html +++ b/docs/interfaces/Factor.html @@ -1,3 +1,60 @@ -Factor | @auth0/auth0-angular
                                                                                                                                                                                                                                          @auth0/auth0-angular
                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                            Interface Factor

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

                                                                                                                                                                                                                                            Properties

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

                                                                                                                                                                                                                                              Interface Factor

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

                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                              usage?: ("primary" | "secondary")[]
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                              usage?: ("primary" | "secondary")[]
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              diff --git a/docs/interfaces/GetTokenSilentlyOptions.html b/docs/interfaces/GetTokenSilentlyOptions.html index fa765c49..172f2425 100644 --- a/docs/interfaces/GetTokenSilentlyOptions.html +++ b/docs/interfaces/GetTokenSilentlyOptions.html @@ -1,25 +1,111 @@ -GetTokenSilentlyOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                              @auth0/auth0-angular
                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                Interface GetTokenSilentlyOptions

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

                                                                                                                                                                                                                                                Properties

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

                                                                                                                                                                                                                                                  Interface GetTokenSilentlyOptions

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

                                                                                                                                                                                                                                                  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?: "off" | "on" | "cache-only"

                                                                                                                                                                                                                                                  When off, ignores the cache and always sends a +

                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                  Optionalscope?: string
                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                  The scope that was used in the authentication request

                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                  cacheMode?: "off" | "on" | "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.

                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                  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.

                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/GetTokenWithPopupOptions.html b/docs/interfaces/GetTokenWithPopupOptions.html index b5228956..e2dd0212 100644 --- a/docs/interfaces/GetTokenWithPopupOptions.html +++ b/docs/interfaces/GetTokenWithPopupOptions.html @@ -1,8 +1,74 @@ -GetTokenWithPopupOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                  @auth0/auth0-angular
                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                    Interface GetTokenWithPopupOptions

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

                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                    Properties

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

                                                                                                                                                                                                                                                      Interface GetTokenWithPopupOptions

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

                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      Index
                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      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?: "off" | "on" | "cache-only"

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

                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                      cacheMode?: "off" | "on" | "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.

                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/HttpInterceptorConfig.html b/docs/interfaces/HttpInterceptorConfig.html index 1002942e..b83756fe 100644 --- a/docs/interfaces/HttpInterceptorConfig.html +++ b/docs/interfaces/HttpInterceptorConfig.html @@ -1,396 +1,57 @@ - - - - - - HttpInterceptorConfig | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        - -

                                                                                                                                                                                                                                                        Interface HttpInterceptorConfig

                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                        Configuration for the HttpInterceptor

                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        - interface - HttpInterceptorConfig - {
                                                                                                                                                                                                                                                            allowedList: - ApiRouteDefinition[];
                                                                                                                                                                                                                                                        } -
                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        - - -
                                                                                                                                                                                                                                                        Index
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        - - -

                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                        - allowedList: - ApiRouteDefinition[] -
                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        - - -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        - - +HttpInterceptorConfig | @auth0/auth0-angular
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        @auth0/auth0-angular + +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                          Interface HttpInterceptorConfig

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                          Configuration for the HttpInterceptor

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          interface HttpInterceptorConfig {
                                                                                                                                                                                                                                                              allowedList: ApiRouteDefinition[];
                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Index
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                          allowedList: ApiRouteDefinition[]
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/HttpInterceptorRouteConfig.html b/docs/interfaces/HttpInterceptorRouteConfig.html index 335b7070..ae59631f 100644 --- a/docs/interfaces/HttpInterceptorRouteConfig.html +++ b/docs/interfaces/HttpInterceptorRouteConfig.html @@ -1,693 +1,111 @@ - - - - - - HttpInterceptorRouteConfig | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                          - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - -

                                                                                                                                                                                                                                                            Interface HttpInterceptorRouteConfig

                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                            Configuration for a single interceptor route

                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - interface - HttpInterceptorRouteConfig - {
                                                                                                                                                                                                                                                                allowAnonymous?: - boolean;
                                                                                                                                                                                                                                                                httpMethod?: - string;
                                                                                                                                                                                                                                                                tokenOptions?: - GetTokenSilentlyOptions;
                                                                                                                                                                                                                                                                uri?: - string;
                                                                                                                                                                                                                                                                uriMatcher?: - (uri: - string) - => - boolean;
                                                                                                                                                                                                                                                            } -
                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - - -
                                                                                                                                                                                                                                                            Index
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - - -

                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                            - allowAnonymous?: - boolean -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                            - Allow the HTTP call to be executed anonymously, when no token - is available. -

                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                            - When omitted (or set to false), calls that match the - configuration will fail when no token is available. -

                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                            - httpMethod?: - string -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                            - The HTTP method to match on. If specified, the HTTP method of - the outgoing request will be checked against this. If there is - no match, the Authorization header is not attached. -

                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                            The HTTP method name is case-sensitive.

                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                            - tokenOptions?: - GetTokenSilentlyOptions -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                            - The options that are passed to the SDK when retrieving the - access token to attach to the outgoing request. -

                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                            - uri?: - string -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                            - The URL to test, by supplying the URL to match. If - test is a match for the current request path from - the HTTP client, then an access token is attached to the - request in the - "Authorization" header. -

                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                            - If the test does not pass, the request proceeds without the - access token attached. -

                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                            - A wildcard character can be used to match only the start of - the URL. -

                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - -

                                                                                                                                                                                                                                                            - '/api' - exactly match the route /api '/api/*' - match any - route that starts with /api/ -

                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                            - uriMatcher?: - (uri: - string) - => - boolean -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                            - A function that will be called with the HttpRequest.url value, - allowing you to do any kind of flexible matching. -

                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                            - If this function returns true, then an access token is - attached to the request in the - "Authorization" header. -

                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                            - If it returns false, the request proceeds without the access - token attached. -

                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - - -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - - +HttpInterceptorRouteConfig | @auth0/auth0-angular
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            @auth0/auth0-angular + +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                              Interface HttpInterceptorRouteConfig

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              Configuration for a single interceptor route

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              interface HttpInterceptorRouteConfig {
                                                                                                                                                                                                                                                                  allowAnonymous?: boolean;
                                                                                                                                                                                                                                                                  httpMethod?: string;
                                                                                                                                                                                                                                                                  tokenOptions?: GetTokenSilentlyOptions;
                                                                                                                                                                                                                                                                  uri?: string;
                                                                                                                                                                                                                                                                  uriMatcher?: (uri: string) => boolean;
                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Index
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                              allowAnonymous?: boolean
                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              Allow the HTTP call to be executed anonymously, when no token is available.

                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              When omitted (or set to false), calls that match the configuration will fail when no token is available.

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                              httpMethod?: string
                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              The HTTP method to match on. If specified, the HTTP method of +the outgoing request will be checked against this. If there is no match, the +Authorization header is not attached.

                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              The HTTP method name is case-sensitive.

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + + +

                                                                                                                                                                                                                                                              The options that are passed to the SDK when retrieving the +access token to attach to the outgoing request.

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                              uri?: string
                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              The URL to test, by supplying the URL to match. +If test is a match for the current request path from the HTTP client, then +an access token is attached to the request in the +"Authorization" header.

                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              If the test does not pass, the request proceeds without the access token attached.

                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              A wildcard character can be used to match only the start of the URL.

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              '/api' - exactly match the route /api +'/api/*' - match any route that starts with /api/

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                              uriMatcher?: (uri: string) => boolean
                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              A function that will be called with the HttpRequest.url value, allowing you to do +any kind of flexible matching.

                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              If this function returns true, then +an access token is attached to the request in the +"Authorization" header.

                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              If it returns false, the request proceeds without the access token attached.

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/ICache.html b/docs/interfaces/ICache.html index c36b664b..bb827d6f 100644 --- a/docs/interfaces/ICache.html +++ b/docs/interfaces/ICache.html @@ -1,5 +1,113 @@ -ICache | @auth0/auth0-angular
                                                                                                                                                                                                                                                              @auth0/auth0-angular
                                                                                                                                                                                                                                                                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-angular
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  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

                                                                                                                                                                                                                                                                  • 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>

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

                                                                                                                                                                                                                                                                    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>

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/IdToken.html b/docs/interfaces/IdToken.html index f86aaaf0..a77afba3 100644 --- a/docs/interfaces/IdToken.html +++ b/docs/interfaces/IdToken.html @@ -1,2264 +1,300 @@ - - - - - - IdToken | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    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: - 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). 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 -
                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    - - +IdToken | @auth0/auth0-angular
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      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: 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). +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
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/LogoutOptions.html b/docs/interfaces/LogoutOptions.html index 32566303..c62c1836 100644 --- a/docs/interfaces/LogoutOptions.html +++ b/docs/interfaces/LogoutOptions.html @@ -1,713 +1,122 @@ - - - - - - LogoutOptions | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                      - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        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

                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        - - -

                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                        - 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 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, 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. -

                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          - 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. However, if the - client_id parameter is not included, the - 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. -

                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                        - 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);
                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                        }); +LogoutOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          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?: 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 +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, +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.

                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            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. +However, if the client_id parameter is not included, the +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.

                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          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);
                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                          });
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          - -
                                                                                                                                                                                                                                                                          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 });
                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                          });
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          - -
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          - - -
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          - - + +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/MyAccountApiClient.html b/docs/interfaces/MyAccountApiClient.html index 85febfce..c62829dc 100644 --- a/docs/interfaces/MyAccountApiClient.html +++ b/docs/interfaces/MyAccountApiClient.html @@ -1,4 +1,17 @@ -MyAccountApiClient | @auth0/auth0-angular
                                                                                                                                                                                                                                                                          @auth0/auth0-angular
                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                            Interface MyAccountApiClient

                                                                                                                                                                                                                                                                            Client for Auth0 MyAccount API operations.

                                                                                                                                                                                                                                                                            +MyAccountApiClient | @auth0/auth0-angular
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              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

                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              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

                                                                                                                                                                                                                                                                              • 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

                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                              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

                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/ObservableMfaApiClient.html b/docs/interfaces/ObservableMfaApiClient.html index f13839b4..8bdaa7b7 100644 --- a/docs/interfaces/ObservableMfaApiClient.html +++ b/docs/interfaces/ObservableMfaApiClient.html @@ -1,1036 +1,155 @@ - - - - - - ObservableMfaApiClient | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                              - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                - -

                                                                                                                                                                                                                                                                                Interface ObservableMfaApiClient

                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                - Observable-based MFA API client exposed by - AuthService.mfa. -

                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                - This is the Angular counterpart of MfaApiClient from - @auth0/auth0-spa-js. All methods return - Observable instead of Promise. -

                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                - interface - ObservableMfaApiClient - {
                                                                                                                                                                                                                                                                                    challenge(
                                                                                                                                                                                                                                                                                        params: - ChallengeAuthenticatorParams,
                                                                                                                                                                                                                                                                                    ): - Observable<ChallengeResponse>;
                                                                                                                                                                                                                                                                                    enroll(params: - EnrollParams): - Observable<EnrollmentResponse>;
                                                                                                                                                                                                                                                                                    getAuthenticators(mfaToken: - string): - Observable<Authenticator[]>;
                                                                                                                                                                                                                                                                                    getEnrollmentFactors(mfaToken: - string): - Observable<EnrollmentFactor[]>;
                                                                                                                                                                                                                                                                                    verify(params: - VerifyParams): - Observable<TokenEndpointResponse>;
                                                                                                                                                                                                                                                                                } -
                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                - - -
                                                                                                                                                                                                                                                                                Index
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                - - -

                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                - - -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                - - -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                • - -
                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  - Returns the list of enrolled MFA authenticators for the - current user, filtered by the challenge types stored in - the MFA context. -

                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                  • - mfaToken: - string -
                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  - Returns Observable<Authenticator[]> -

                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                • - -
                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  - Returns the available enrollment factors from the stored - MFA context. A non-empty result means the user must - enroll before they can authenticate. -

                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                  • - mfaToken: - string -
                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  - Returns Observable<EnrollmentFactor[]> -

                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                • - -
                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  - Verifies an MFA challenge and returns raw tokens. The - grant type is inferred automatically from the provided - field: otp, oobCode, or - recoveryCode. Angular auth state - (isAuthenticated$, user$) is - not updated automatically — call - getAccessTokenSilently() afterwards to - reflect the new session. -

                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  - Returns Observable<TokenEndpointResponse> -

                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                - - -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                - - +ObservableMfaApiClient | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                  Interface ObservableMfaApiClient

                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Observable-based MFA API client exposed by AuthService.mfa.

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  This is the Angular counterpart of MfaApiClient from @auth0/auth0-spa-js. +All methods return Observable instead of Promise.

                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  interface ObservableMfaApiClient {
                                                                                                                                                                                                                                                                                      challenge(
                                                                                                                                                                                                                                                                                          params: ChallengeAuthenticatorParams,
                                                                                                                                                                                                                                                                                      ): Observable<ChallengeResponse>;
                                                                                                                                                                                                                                                                                      enroll(params: EnrollParams): Observable<EnrollmentResponse>;
                                                                                                                                                                                                                                                                                      getAuthenticators(mfaToken: string): Observable<Authenticator[]>;
                                                                                                                                                                                                                                                                                      getEnrollmentFactors(mfaToken: string): Observable<EnrollmentFactor[]>;
                                                                                                                                                                                                                                                                                      verify(params: VerifyParams): Observable<TokenEndpointResponse>;
                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  Index
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/ObservableMyAccountApiClient.html b/docs/interfaces/ObservableMyAccountApiClient.html index 7040ebc6..77dc05d3 100644 --- a/docs/interfaces/ObservableMyAccountApiClient.html +++ b/docs/interfaces/ObservableMyAccountApiClient.html @@ -1,1313 +1,186 @@ - - - - - - ObservableMyAccountApiClient | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                                                                    Interface ObservableMyAccountApiClient

                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    - Observable-based MyAccount API client exposed by - AuthService.myAccount. -

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    - This is the Angular counterpart of - MyAccountApiClient from - @auth0/auth0-spa-js. All methods return - Observable instead of Promise. -

                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    - interface - ObservableMyAccountApiClient - {
                                                                                                                                                                                                                                                                                        deleteAuthenticationMethod(id: - string): - Observable<void>;
                                                                                                                                                                                                                                                                                        enrollmentChallenge(
                                                                                                                                                                                                                                                                                            options: - EnrollmentChallengeOptions,
                                                                                                                                                                                                                                                                                        ): - Observable<EnrollmentChallengeResponse>;
                                                                                                                                                                                                                                                                                        enrollmentVerify(
                                                                                                                                                                                                                                                                                            options: - EnrollmentVerifyOptions,
                                                                                                                                                                                                                                                                                        ): - Observable<AuthenticationMethod>;
                                                                                                                                                                                                                                                                                        getAuthenticationMethod(id: - string): - Observable<AuthenticationMethod>;
                                                                                                                                                                                                                                                                                        getAuthenticationMethods(
                                                                                                                                                                                                                                                                                            type?: - AuthenticationMethodType,
                                                                                                                                                                                                                                                                                        ): - Observable<AuthenticationMethod[]>;
                                                                                                                                                                                                                                                                                        getFactors(): - Observable<Factor[]>;
                                                                                                                                                                                                                                                                                        updateAuthenticationMethod(
                                                                                                                                                                                                                                                                                            id: - string,
                                                                                                                                                                                                                                                                                            data: - UpdateAuthenticationMethodRequest,
                                                                                                                                                                                                                                                                                        ): - Observable<AuthenticationMethod>;
                                                                                                                                                                                                                                                                                    } -
                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                                                                                    Index
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    - - -

                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                    • - -
                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Deletes the specified authentication method.

                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                      • - id: - string -
                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      - Returns Observable<void> -

                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                      - -
                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                      - -
                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    - - +ObservableMyAccountApiClient | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                      Interface ObservableMyAccountApiClient

                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Observable-based MyAccount API client exposed by AuthService.myAccount.

                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      This is the Angular counterpart of MyAccountApiClient from @auth0/auth0-spa-js. +All methods return Observable instead of Promise.

                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      interface ObservableMyAccountApiClient {
                                                                                                                                                                                                                                                                                          deleteAuthenticationMethod(id: string): Observable<void>;
                                                                                                                                                                                                                                                                                          enrollmentChallenge(
                                                                                                                                                                                                                                                                                              options: EnrollmentChallengeOptions,
                                                                                                                                                                                                                                                                                          ): Observable<EnrollmentChallengeResponse>;
                                                                                                                                                                                                                                                                                          enrollmentVerify(
                                                                                                                                                                                                                                                                                              options: EnrollmentVerifyOptions,
                                                                                                                                                                                                                                                                                          ): Observable<AuthenticationMethod>;
                                                                                                                                                                                                                                                                                          getAuthenticationMethod(id: string): Observable<AuthenticationMethod>;
                                                                                                                                                                                                                                                                                          getAuthenticationMethods(
                                                                                                                                                                                                                                                                                              type?: AuthenticationMethodType,
                                                                                                                                                                                                                                                                                          ): Observable<AuthenticationMethod[]>;
                                                                                                                                                                                                                                                                                          getFactors(): Observable<Factor[]>;
                                                                                                                                                                                                                                                                                          updateAuthenticationMethod(
                                                                                                                                                                                                                                                                                              id: string,
                                                                                                                                                                                                                                                                                              data: UpdateAuthenticationMethodRequest,
                                                                                                                                                                                                                                                                                          ): Observable<AuthenticationMethod>;
                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      Index
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/ObservablePasskeyApiClient.html b/docs/interfaces/ObservablePasskeyApiClient.html index ba62256e..48b05faa 100644 --- a/docs/interfaces/ObservablePasskeyApiClient.html +++ b/docs/interfaces/ObservablePasskeyApiClient.html @@ -1,675 +1,102 @@ - - - - - - ObservablePasskeyApiClient | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                      - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        - -

                                                                                                                                                                                                                                                                                        Interface ObservablePasskeyApiClient

                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        - Observable-based Passkey API client exposed by - AuthService.passkey. -

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        - Wraps PasskeyApiClient from - @auth0/auth0-spa-js. Both methods handle the full - WebAuthn flow internally and update Angular auth state on success. - All methods return Observable instead of - Promise. -

                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        - interface - ObservablePasskeyApiClient - {
                                                                                                                                                                                                                                                                                            login(options?: - PasskeyLoginOptions): - Observable<TokenEndpointResponse>;
                                                                                                                                                                                                                                                                                            signup(options: - PasskeySignupOptions): - Observable<TokenEndpointResponse>;
                                                                                                                                                                                                                                                                                        } -
                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        - - -
                                                                                                                                                                                                                                                                                        Index
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        - - -

                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        - - -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        - - -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        - - -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        - - +ObservablePasskeyApiClient | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                          Interface ObservablePasskeyApiClient

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Observable-based Passkey API client exposed by AuthService.passkey.

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Wraps PasskeyApiClient from @auth0/auth0-spa-js. Both methods handle the +full WebAuthn flow internally and update Angular auth state on success. +All methods return Observable instead of Promise.

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          interface ObservablePasskeyApiClient {
                                                                                                                                                                                                                                                                                              login(options?: PasskeyLoginOptions): Observable<TokenEndpointResponse>;
                                                                                                                                                                                                                                                                                              signup(options: PasskeySignupOptions): Observable<TokenEndpointResponse>;
                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          Index
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/OobEnrollmentResponse.html b/docs/interfaces/OobEnrollmentResponse.html index f923d2e0..27b49087 100644 --- a/docs/interfaces/OobEnrollmentResponse.html +++ b/docs/interfaces/OobEnrollmentResponse.html @@ -1,16 +1,107 @@ -OobEnrollmentResponse | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                          @auth0/auth0-angular
                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                            Interface OobEnrollmentResponse

                                                                                                                                                                                                                                                                                            Response when enrolling an OOB authenticator

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            interface OobEnrollmentResponse {
                                                                                                                                                                                                                                                                                                authenticatorType: "oob";
                                                                                                                                                                                                                                                                                                barcodeUri?: string;
                                                                                                                                                                                                                                                                                                bindingMethod?: string;
                                                                                                                                                                                                                                                                                                id?: string;
                                                                                                                                                                                                                                                                                                oobChannel: OobChannel;
                                                                                                                                                                                                                                                                                                oobCode?: string;
                                                                                                                                                                                                                                                                                                recoveryCodes?: string[];
                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                            authenticatorType +OobEnrollmentResponse | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                              Interface OobEnrollmentResponse

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Response when enrolling an OOB authenticator

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              interface OobEnrollmentResponse {
                                                                                                                                                                                                                                                                                                  authenticatorType: "oob";
                                                                                                                                                                                                                                                                                                  barcodeUri?: string;
                                                                                                                                                                                                                                                                                                  bindingMethod?: string;
                                                                                                                                                                                                                                                                                                  id?: string;
                                                                                                                                                                                                                                                                                                  oobChannel: OobChannel;
                                                                                                                                                                                                                                                                                                  oobCode?: string;
                                                                                                                                                                                                                                                                                                  recoveryCodes?: string[];
                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              Index
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                              authenticatorType: "oob"

                                                                                                                                                                                                                                                                                              Authenticator type

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              barcodeUri?: string

                                                                                                                                                                                                                                                                                              URI for QR code (for Push/Guardian enrollment)

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              bindingMethod?: string

                                                                                                                                                                                                                                                                                              Binding method (e.g., 'prompt' for user code entry)

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              id?: string

                                                                                                                                                                                                                                                                                              Authenticator ID

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              oobChannel: OobChannel

                                                                                                                                                                                                                                                                                              Delivery channel used

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              oobCode?: string

                                                                                                                                                                                                                                                                                              Out-of-band code for verification

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              recoveryCodes?: string[]

                                                                                                                                                                                                                                                                                              Recovery codes (generated when enrolling first MFA factor)

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              authenticatorType: "oob"
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Authenticator type

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              barcodeUri?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              URI for QR code (for Push/Guardian enrollment)

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              bindingMethod?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Binding method (e.g., 'prompt' for user code entry)

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              id?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Authenticator ID

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              oobChannel: OobChannel
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Delivery channel used

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              oobCode?: string
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Out-of-band code for verification

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              recoveryCodes?: string[]
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Recovery codes (generated when enrolling first MFA factor)

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/OtpEnrollmentResponse.html b/docs/interfaces/OtpEnrollmentResponse.html index 85ac3ed5..c3c07ddb 100644 --- a/docs/interfaces/OtpEnrollmentResponse.html +++ b/docs/interfaces/OtpEnrollmentResponse.html @@ -1,12 +1,91 @@ -OtpEnrollmentResponse | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                              @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                Interface OtpEnrollmentResponse

                                                                                                                                                                                                                                                                                                Response when enrolling an OTP authenticator

                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                interface OtpEnrollmentResponse {
                                                                                                                                                                                                                                                                                                    authenticatorType: "otp";
                                                                                                                                                                                                                                                                                                    barcodeUri: string;
                                                                                                                                                                                                                                                                                                    id?: string;
                                                                                                                                                                                                                                                                                                    recoveryCodes?: string[];
                                                                                                                                                                                                                                                                                                    secret: string;
                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                authenticatorType +OtpEnrollmentResponse | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                  Interface OtpEnrollmentResponse

                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                  Response when enrolling an OTP authenticator

                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  interface OtpEnrollmentResponse {
                                                                                                                                                                                                                                                                                                      authenticatorType: "otp";
                                                                                                                                                                                                                                                                                                      barcodeUri: string;
                                                                                                                                                                                                                                                                                                      id?: string;
                                                                                                                                                                                                                                                                                                      recoveryCodes?: string[];
                                                                                                                                                                                                                                                                                                      secret: string;
                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  Index
                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                  authenticatorType: "otp"

                                                                                                                                                                                                                                                                                                  Authenticator type

                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                  barcodeUri: string

                                                                                                                                                                                                                                                                                                  URI for generating QR code (otpauth://...)

                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                  id?: string

                                                                                                                                                                                                                                                                                                  Authenticator ID

                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                  recoveryCodes?: string[]

                                                                                                                                                                                                                                                                                                  Recovery codes for account recovery

                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                  secret: string

                                                                                                                                                                                                                                                                                                  Base32-encoded secret for TOTP generation

                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                  authenticatorType: "otp"
                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                  Authenticator type

                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                  barcodeUri: string
                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                  URI for generating QR code (otpauth://...)

                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                  id?: string
                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                  Authenticator ID

                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                  recoveryCodes?: string[]
                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                  Recovery codes for account recovery

                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                  secret: string
                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                  Base32-encoded secret for TOTP generation

                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/PasskeyApiClient.html b/docs/interfaces/PasskeyApiClient.html index 6750ab01..4ed62527 100644 --- a/docs/interfaces/PasskeyApiClient.html +++ b/docs/interfaces/PasskeyApiClient.html @@ -1,32 +1,132 @@ -PasskeyApiClient | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                  @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                    Interface PasskeyApiClient

                                                                                                                                                                                                                                                                                                    Client for Auth0 Passkey operations.

                                                                                                                                                                                                                                                                                                    +PasskeyApiClient | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      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

                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      interface PasskeyApiClient {
                                                                                                                                                                                                                                                                                                          login(options?: PasskeyLoginOptions): Promise<TokenEndpointResponse>;
                                                                                                                                                                                                                                                                                                          signup(options: PasskeySignupOptions): Promise<TokenEndpointResponse>;
                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      Index
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                      • + +
                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                        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

                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                      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

                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/PasskeyAuthenticationMethod.html b/docs/interfaces/PasskeyAuthenticationMethod.html index 3f260da0..60139e01 100644 --- a/docs/interfaces/PasskeyAuthenticationMethod.html +++ b/docs/interfaces/PasskeyAuthenticationMethod.html @@ -1,1108 +1,147 @@ - - - - - - PasskeyAuthenticationMethod | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                      - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        - -

                                                                                                                                                                                                                                                                                                        Interface PasskeyAuthenticationMethod

                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        - interface - PasskeyAuthenticationMethod - {
                                                                                                                                                                                                                                                                                                            aaguid?: - string;
                                                                                                                                                                                                                                                                                                            created_at: - string;
                                                                                                                                                                                                                                                                                                            credential_backed_up: - boolean;
                                                                                                                                                                                                                                                                                                            credential_device_type: - "single_device" - | - "multi_device";
                                                                                                                                                                                                                                                                                                            id: - string;
                                                                                                                                                                                                                                                                                                            identity_user_id: - string;
                                                                                                                                                                                                                                                                                                            key_id: - string;
                                                                                                                                                                                                                                                                                                            last_auth_at?: - string;
                                                                                                                                                                                                                                                                                                            public_key: - string;
                                                                                                                                                                                                                                                                                                            relying_party_id?: - string;
                                                                                                                                                                                                                                                                                                            transports?: - string[];
                                                                                                                                                                                                                                                                                                            type: - "passkey";
                                                                                                                                                                                                                                                                                                            usage: ("primary" - | - "secondary")[];
                                                                                                                                                                                                                                                                                                            user_agent?: - string;
                                                                                                                                                                                                                                                                                                            user_handle: - string;
                                                                                                                                                                                                                                                                                                        } -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                        • - AuthenticationMethodBase -
                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                          • - PasskeyAuthenticationMethod -
                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        - - -
                                                                                                                                                                                                                                                                                                        Index
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        - - -

                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                        - aaguid?: - string -
                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                        - created_at: - string -
                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                        - credential_backed_up: - boolean -
                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                        - credential_device_type: - "single_device" - | - "multi_device" -
                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                        - id: - string -
                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                        - identity_user_id: - string -
                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                        - key_id: - string -
                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                        - last_auth_at?: - string -
                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                        - public_key: - string -
                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                        - relying_party_id?: - string -
                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                        - transports?: - string[] -
                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                        - type: - "passkey" -
                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                        - usage: ("primary" - | - "secondary")[] -
                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                        - user_agent?: - string -
                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                        - user_handle: - string -
                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        - - -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        - - +PasskeyAuthenticationMethod | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                          Interface PasskeyAuthenticationMethod

                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          interface PasskeyAuthenticationMethod {
                                                                                                                                                                                                                                                                                                              aaguid?: string;
                                                                                                                                                                                                                                                                                                              created_at: string;
                                                                                                                                                                                                                                                                                                              credential_backed_up: boolean;
                                                                                                                                                                                                                                                                                                              credential_device_type: "single_device" | "multi_device";
                                                                                                                                                                                                                                                                                                              id: string;
                                                                                                                                                                                                                                                                                                              identity_user_id: string;
                                                                                                                                                                                                                                                                                                              key_id: string;
                                                                                                                                                                                                                                                                                                              last_auth_at?: string;
                                                                                                                                                                                                                                                                                                              public_key: string;
                                                                                                                                                                                                                                                                                                              relying_party_id?: string;
                                                                                                                                                                                                                                                                                                              transports?: string[];
                                                                                                                                                                                                                                                                                                              type: "passkey";
                                                                                                                                                                                                                                                                                                              usage: ("primary" | "secondary")[];
                                                                                                                                                                                                                                                                                                              user_agent?: string;
                                                                                                                                                                                                                                                                                                              user_handle: string;
                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                          • AuthenticationMethodBase +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                            • PasskeyAuthenticationMethod
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          Index
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                          aaguid?: string
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                          created_at: string
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                          credential_backed_up: boolean
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                          credential_device_type: "single_device" | "multi_device"
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                          id: string
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                          identity_user_id: string
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                          key_id: string
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                          last_auth_at?: string
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                          public_key: string
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                          relying_party_id?: string
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                          transports?: string[]
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                          type: "passkey"
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                          usage: ("primary" | "secondary")[]
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                          user_agent?: string
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                          user_handle: string
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/PasskeyCreationOptions.html b/docs/interfaces/PasskeyCreationOptions.html index 86a80730..9d99d95f 100644 --- a/docs/interfaces/PasskeyCreationOptions.html +++ b/docs/interfaces/PasskeyCreationOptions.html @@ -1,701 +1,87 @@ - - - - - - PasskeyCreationOptions | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                            - -

                                                                                                                                                                                                                                                                                                            Interface PasskeyCreationOptions

                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                            - Public key credential creation options returned by signup - challenges. -

                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                            - interface - PasskeyCreationOptions - {
                                                                                                                                                                                                                                                                                                                authenticatorSelection?: - {
                                                                                                                                                                                                                                                                                                                    residentKey?: - string;
                                                                                                                                                                                                                                                                                                                    userVerification?: - string;
                                                                                                                                                                                                                                                                                                                };
                                                                                                                                                                                                                                                                                                                challenge: - string;
                                                                                                                                                                                                                                                                                                                pubKeyCredParams: - { - alg: - number; - type: - string - }[];
                                                                                                                                                                                                                                                                                                                rp: - { - id: - string; - name: - string - };
                                                                                                                                                                                                                                                                                                                timeout?: - number;
                                                                                                                                                                                                                                                                                                                user: - { - displayName: - string; - id: - string; - name: - string - };
                                                                                                                                                                                                                                                                                                            } -
                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                            - - -
                                                                                                                                                                                                                                                                                                            Index
                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                            - - -

                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                            - authenticatorSelection?: - { - residentKey?: - string; - userVerification?: - string - } -
                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                            - challenge: - string -
                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                            - pubKeyCredParams: - { - alg: - number; - type: - string - }[] -
                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                            - rp: - { - id: - string; - name: - string - } -
                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                            - timeout?: - number -
                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                            - user: - { - displayName: - string; - id: - string; - name: - string - } -
                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                            - - -
                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                            - - +PasskeyCreationOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                              Interface PasskeyCreationOptions

                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                              Public key credential creation options returned by signup challenges.

                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              interface PasskeyCreationOptions {
                                                                                                                                                                                                                                                                                                                  authenticatorSelection?: {
                                                                                                                                                                                                                                                                                                                      residentKey?: string;
                                                                                                                                                                                                                                                                                                                      userVerification?: string;
                                                                                                                                                                                                                                                                                                                  };
                                                                                                                                                                                                                                                                                                                  challenge: string;
                                                                                                                                                                                                                                                                                                                  pubKeyCredParams: { alg: number; type: string }[];
                                                                                                                                                                                                                                                                                                                  rp: { id: string; name: string };
                                                                                                                                                                                                                                                                                                                  timeout?: number;
                                                                                                                                                                                                                                                                                                                  user: { displayName: string; id: string; name: string };
                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              Index
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                              authenticatorSelection?: { residentKey?: string; userVerification?: string }
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                              challenge: string
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                              pubKeyCredParams: { alg: number; type: string }[]
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                              rp: { id: string; name: string }
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                              timeout?: number
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                              user: { displayName: string; id: string; name: string }
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/PasskeyCredentialResponse.html b/docs/interfaces/PasskeyCredentialResponse.html index 5670f1c2..38df267a 100644 --- a/docs/interfaces/PasskeyCredentialResponse.html +++ b/docs/interfaces/PasskeyCredentialResponse.html @@ -1,689 +1,88 @@ - - - - - - PasskeyCredentialResponse | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                              - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                - -

                                                                                                                                                                                                                                                                                                                Interface PasskeyCredentialResponse

                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                - Serialized credential response from the platform WebAuthn API. All - binary fields (rawId, clientDataJSON, etc.) must be - base64url-encoded strings. -

                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                - interface - PasskeyCredentialResponse - {
                                                                                                                                                                                                                                                                                                                    authenticatorAttachment?: - string;
                                                                                                                                                                                                                                                                                                                    clientExtensionResults?: - Record<string, - unknown>;
                                                                                                                                                                                                                                                                                                                    id: - string;
                                                                                                                                                                                                                                                                                                                    rawId: - string;
                                                                                                                                                                                                                                                                                                                    response: - {
                                                                                                                                                                                                                                                                                                                        attestationObject?: - string;
                                                                                                                                                                                                                                                                                                                        authenticatorData?: - string;
                                                                                                                                                                                                                                                                                                                        clientDataJSON: - string;
                                                                                                                                                                                                                                                                                                                        signature?: - string;
                                                                                                                                                                                                                                                                                                                        userHandle?: - string;
                                                                                                                                                                                                                                                                                                                    };
                                                                                                                                                                                                                                                                                                                    type: - string;
                                                                                                                                                                                                                                                                                                                } -
                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                - - -
                                                                                                                                                                                                                                                                                                                Index
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                - - -

                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                - authenticatorAttachment?: - string -
                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                - clientExtensionResults?: - Record<string, - unknown> -
                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                - id: - string -
                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                - rawId: - string -
                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                - response: - {
                                                                                                                                                                                                                                                                                                                    attestationObject?: - string;
                                                                                                                                                                                                                                                                                                                    authenticatorData?: - string;
                                                                                                                                                                                                                                                                                                                    clientDataJSON: - string;
                                                                                                                                                                                                                                                                                                                    signature?: - string;
                                                                                                                                                                                                                                                                                                                    userHandle?: - string;
                                                                                                                                                                                                                                                                                                                } -
                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                - type: - string -
                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                - - -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                - - +PasskeyCredentialResponse | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                  Interface PasskeyCredentialResponse

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                  Serialized credential response from the platform WebAuthn API. +All binary fields (rawId, clientDataJSON, etc.) must be base64url-encoded strings.

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  interface PasskeyCredentialResponse {
                                                                                                                                                                                                                                                                                                                      authenticatorAttachment?: string;
                                                                                                                                                                                                                                                                                                                      clientExtensionResults?: Record<string, unknown>;
                                                                                                                                                                                                                                                                                                                      id: string;
                                                                                                                                                                                                                                                                                                                      rawId: string;
                                                                                                                                                                                                                                                                                                                      response: {
                                                                                                                                                                                                                                                                                                                          attestationObject?: string;
                                                                                                                                                                                                                                                                                                                          authenticatorData?: string;
                                                                                                                                                                                                                                                                                                                          clientDataJSON: string;
                                                                                                                                                                                                                                                                                                                          signature?: string;
                                                                                                                                                                                                                                                                                                                          userHandle?: string;
                                                                                                                                                                                                                                                                                                                      };
                                                                                                                                                                                                                                                                                                                      type: string;
                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  Index
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                  authenticatorAttachment?: string
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                  clientExtensionResults?: Record<string, unknown>
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                  id: string
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                  rawId: string
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                  response: {
                                                                                                                                                                                                                                                                                                                      attestationObject?: string;
                                                                                                                                                                                                                                                                                                                      authenticatorData?: string;
                                                                                                                                                                                                                                                                                                                      clientDataJSON: string;
                                                                                                                                                                                                                                                                                                                      signature?: string;
                                                                                                                                                                                                                                                                                                                      userHandle?: string;
                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                  type: string
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/PasskeyEnrollmentChallengeOptions.html b/docs/interfaces/PasskeyEnrollmentChallengeOptions.html index 3dc74292..509ce920 100644 --- a/docs/interfaces/PasskeyEnrollmentChallengeOptions.html +++ b/docs/interfaces/PasskeyEnrollmentChallengeOptions.html @@ -1,4 +1,66 @@ -PasskeyEnrollmentChallengeOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                  @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                    Interface PasskeyEnrollmentChallengeOptions

                                                                                                                                                                                                                                                                                                                    interface PasskeyEnrollmentChallengeOptions {
                                                                                                                                                                                                                                                                                                                        connection?: string;
                                                                                                                                                                                                                                                                                                                        identity_user_id?: string;
                                                                                                                                                                                                                                                                                                                        type: "passkey";
                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                    connection? +PasskeyEnrollmentChallengeOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                      Interface PasskeyEnrollmentChallengeOptions

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      interface PasskeyEnrollmentChallengeOptions {
                                                                                                                                                                                                                                                                                                                          connection?: string;
                                                                                                                                                                                                                                                                                                                          identity_user_id?: string;
                                                                                                                                                                                                                                                                                                                          type: "passkey";
                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      Index
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                      connection?: string
                                                                                                                                                                                                                                                                                                                      identity_user_id?: string
                                                                                                                                                                                                                                                                                                                      type: "passkey"
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                      connection?: string
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                      identity_user_id?: string
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                      type: "passkey"
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/PasskeyEnrollmentChallengeResponse.html b/docs/interfaces/PasskeyEnrollmentChallengeResponse.html index 14dfdf20..c557dd87 100644 --- a/docs/interfaces/PasskeyEnrollmentChallengeResponse.html +++ b/docs/interfaces/PasskeyEnrollmentChallengeResponse.html @@ -1,618 +1,87 @@ - - - - - - PasskeyEnrollmentChallengeResponse | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                      - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        - -

                                                                                                                                                                                                                                                                                                                        Interface PasskeyEnrollmentChallengeResponse

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        - interface - PasskeyEnrollmentChallengeResponse - {
                                                                                                                                                                                                                                                                                                                            auth_session: - string;
                                                                                                                                                                                                                                                                                                                            authn_params_public_key: - PasskeyCreationOptions;
                                                                                                                                                                                                                                                                                                                            id: - string;
                                                                                                                                                                                                                                                                                                                            location: - string;
                                                                                                                                                                                                                                                                                                                            type: - "passkey";
                                                                                                                                                                                                                                                                                                                        } -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • - EnrollmentChallengeBaseResponse -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                          • - PasskeyEnrollmentChallengeResponse -
                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        - - -
                                                                                                                                                                                                                                                                                                                        Index
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        - - -

                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                        - auth_session: - string -
                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                        - authn_params_public_key: - PasskeyCreationOptions -
                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                        - id: - string -
                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                        - location: - string -
                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                        - type: - "passkey" -
                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        - - -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        - - +PasskeyEnrollmentChallengeResponse | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                          Interface PasskeyEnrollmentChallengeResponse

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          interface PasskeyEnrollmentChallengeResponse {
                                                                                                                                                                                                                                                                                                                              auth_session: string;
                                                                                                                                                                                                                                                                                                                              authn_params_public_key: PasskeyCreationOptions;
                                                                                                                                                                                                                                                                                                                              id: string;
                                                                                                                                                                                                                                                                                                                              location: string;
                                                                                                                                                                                                                                                                                                                              type: "passkey";
                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                          • EnrollmentChallengeBaseResponse +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                            • PasskeyEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          Index
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                          auth_session: string
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                          authn_params_public_key: PasskeyCreationOptions
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                          id: string
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                          location: string
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                          type: "passkey"
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/PasskeyEnrollmentVerifyOptions.html b/docs/interfaces/PasskeyEnrollmentVerifyOptions.html index 36bdffc7..ccd64c0b 100644 --- a/docs/interfaces/PasskeyEnrollmentVerifyOptions.html +++ b/docs/interfaces/PasskeyEnrollmentVerifyOptions.html @@ -1,558 +1,80 @@ - - - - - - PasskeyEnrollmentVerifyOptions | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                          - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            - -

                                                                                                                                                                                                                                                                                                                            Interface PasskeyEnrollmentVerifyOptions

                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            - interface - PasskeyEnrollmentVerifyOptions - {
                                                                                                                                                                                                                                                                                                                                auth_session: - string;
                                                                                                                                                                                                                                                                                                                                authn_response: - PasskeyCredentialResponse;
                                                                                                                                                                                                                                                                                                                                location: - string;
                                                                                                                                                                                                                                                                                                                                type: - "passkey";
                                                                                                                                                                                                                                                                                                                            } -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                            • - EnrollmentVerifyBaseOptions -
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                              • - PasskeyEnrollmentVerifyOptions -
                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            - - -
                                                                                                                                                                                                                                                                                                                            Index
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            - - -

                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                            - auth_session: - string -
                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                            - authn_response: - PasskeyCredentialResponse -
                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                            - location: - string -
                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                            - type: - "passkey" -
                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            - - -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            - - +PasskeyEnrollmentVerifyOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                              Interface PasskeyEnrollmentVerifyOptions

                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              interface PasskeyEnrollmentVerifyOptions {
                                                                                                                                                                                                                                                                                                                                  auth_session: string;
                                                                                                                                                                                                                                                                                                                                  authn_response: PasskeyCredentialResponse;
                                                                                                                                                                                                                                                                                                                                  location: string;
                                                                                                                                                                                                                                                                                                                                  type: "passkey";
                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                              • EnrollmentVerifyBaseOptions +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                • PasskeyEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              Index
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                              auth_session: string
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                              location: string
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                              type: "passkey"
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/PasskeyErrorResponse.html b/docs/interfaces/PasskeyErrorResponse.html index b43b9cb6..e39076b2 100644 --- a/docs/interfaces/PasskeyErrorResponse.html +++ b/docs/interfaces/PasskeyErrorResponse.html @@ -1,4 +1,66 @@ -PasskeyErrorResponse | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                              @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                Interface PasskeyErrorResponse

                                                                                                                                                                                                                                                                                                                                interface PasskeyErrorResponse {
                                                                                                                                                                                                                                                                                                                                    error: string;
                                                                                                                                                                                                                                                                                                                                    error_description: string;
                                                                                                                                                                                                                                                                                                                                    message?: string;
                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                error +PasskeyErrorResponse | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                  Interface PasskeyErrorResponse

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  interface PasskeyErrorResponse {
                                                                                                                                                                                                                                                                                                                                      error: string;
                                                                                                                                                                                                                                                                                                                                      error_description: string;
                                                                                                                                                                                                                                                                                                                                      message?: string;
                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  Index
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                  error: string
                                                                                                                                                                                                                                                                                                                                  error_description: string
                                                                                                                                                                                                                                                                                                                                  message?: string
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                  error: string
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                  error_description: string
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                  message?: string
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/PasskeyLoginChallengeOptions.html b/docs/interfaces/PasskeyLoginChallengeOptions.html index defec6e6..96382919 100644 --- a/docs/interfaces/PasskeyLoginChallengeOptions.html +++ b/docs/interfaces/PasskeyLoginChallengeOptions.html @@ -1,442 +1,67 @@ - - - - - - PasskeyLoginChallengeOptions | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                  - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                                                                                                                    Interface PasskeyLoginChallengeOptions

                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                    Options for requesting a passkey login challenge.

                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    - interface - PasskeyLoginChallengeOptions - {
                                                                                                                                                                                                                                                                                                                                        organization?: - string;
                                                                                                                                                                                                                                                                                                                                        realm?: - string;
                                                                                                                                                                                                                                                                                                                                    } -
                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                                                                                                                                    Index
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    - - -

                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                    - organization?: - string -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                    - Organization ID or name (scopes tokens to the organization - context) -

                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                    - realm?: - string -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                    - Database connection name (sent as realm to the - API) -

                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    - - +PasskeyLoginChallengeOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                      Interface PasskeyLoginChallengeOptions

                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                      Options for requesting a passkey login challenge.

                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      interface PasskeyLoginChallengeOptions {
                                                                                                                                                                                                                                                                                                                                          organization?: string;
                                                                                                                                                                                                                                                                                                                                          realm?: string;
                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Index
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                      organization?: string
                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                      Organization ID or name (scopes tokens to the organization context)

                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                      realm?: string
                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                      Database connection name (sent as realm to the API)

                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/PasskeyLoginChallengeResponse.html b/docs/interfaces/PasskeyLoginChallengeResponse.html index bf863328..ce545f14 100644 --- a/docs/interfaces/PasskeyLoginChallengeResponse.html +++ b/docs/interfaces/PasskeyLoginChallengeResponse.html @@ -1,442 +1,63 @@ - - - - - - PasskeyLoginChallengeResponse | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                      - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        - -

                                                                                                                                                                                                                                                                                                                                        Interface PasskeyLoginChallengeResponse

                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                        Response from a passkey login challenge request.

                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        - interface - PasskeyLoginChallengeResponse - {
                                                                                                                                                                                                                                                                                                                                            authnParamsPublicKey: - PasskeyRequestOptions;
                                                                                                                                                                                                                                                                                                                                            authSession: - string;
                                                                                                                                                                                                                                                                                                                                        } -
                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        - - -
                                                                                                                                                                                                                                                                                                                                        Index
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        - - -

                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                        - authnParamsPublicKey: - PasskeyRequestOptions -
                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                        - authSession: - string -
                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        - - -
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        - - +PasskeyLoginChallengeResponse | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                          Interface PasskeyLoginChallengeResponse

                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Response from a passkey login challenge request.

                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          interface PasskeyLoginChallengeResponse {
                                                                                                                                                                                                                                                                                                                                              authnParamsPublicKey: PasskeyRequestOptions;
                                                                                                                                                                                                                                                                                                                                              authSession: string;
                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          Index
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                          authnParamsPublicKey: PasskeyRequestOptions
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                          authSession: string
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/PasskeyRequestOptions.html b/docs/interfaces/PasskeyRequestOptions.html index 6cc34372..889e3fdc 100644 --- a/docs/interfaces/PasskeyRequestOptions.html +++ b/docs/interfaces/PasskeyRequestOptions.html @@ -1,528 +1,75 @@ - - - - - - PasskeyRequestOptions | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                            - -

                                                                                                                                                                                                                                                                                                                                            Interface PasskeyRequestOptions

                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                            - Public key credential request options returned by login - challenges. -

                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                            - interface - PasskeyRequestOptions - {
                                                                                                                                                                                                                                                                                                                                                challenge: - string;
                                                                                                                                                                                                                                                                                                                                                rpId: - string;
                                                                                                                                                                                                                                                                                                                                                timeout?: - number;
                                                                                                                                                                                                                                                                                                                                                userVerification?: - string;
                                                                                                                                                                                                                                                                                                                                            } -
                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                            - - -
                                                                                                                                                                                                                                                                                                                                            Index
                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                            - - -

                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                            - challenge: - string -
                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                            - rpId: - string -
                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                            - timeout?: - number -
                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                            - userVerification?: - string -
                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                            - - -
                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                            - - +PasskeyRequestOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                              Interface PasskeyRequestOptions

                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                              Public key credential request options returned by login challenges.

                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              interface PasskeyRequestOptions {
                                                                                                                                                                                                                                                                                                                                                  challenge: string;
                                                                                                                                                                                                                                                                                                                                                  rpId: string;
                                                                                                                                                                                                                                                                                                                                                  timeout?: number;
                                                                                                                                                                                                                                                                                                                                                  userVerification?: string;
                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Index
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                              challenge: string
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                              rpId: string
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                              timeout?: number
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                              userVerification?: string
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/PasskeySignupChallengeResponse.html b/docs/interfaces/PasskeySignupChallengeResponse.html index 1481c2e4..ff3ed719 100644 --- a/docs/interfaces/PasskeySignupChallengeResponse.html +++ b/docs/interfaces/PasskeySignupChallengeResponse.html @@ -1,442 +1,63 @@ - - - - - - PasskeySignupChallengeResponse | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                              - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                - -

                                                                                                                                                                                                                                                                                                                                                Interface PasskeySignupChallengeResponse

                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Response from a passkey signup challenge request.

                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                - interface - PasskeySignupChallengeResponse - {
                                                                                                                                                                                                                                                                                                                                                    authnParamsPublicKey: - PasskeyCreationOptions;
                                                                                                                                                                                                                                                                                                                                                    authSession: - string;
                                                                                                                                                                                                                                                                                                                                                } -
                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                - - -
                                                                                                                                                                                                                                                                                                                                                Index
                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                - - -

                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                - authnParamsPublicKey: - PasskeyCreationOptions -
                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                - authSession: - string -
                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                - - -
                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                - - +PasskeySignupChallengeResponse | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                                  Interface PasskeySignupChallengeResponse

                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                  Response from a passkey signup challenge request.

                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  interface PasskeySignupChallengeResponse {
                                                                                                                                                                                                                                                                                                                                                      authnParamsPublicKey: PasskeyCreationOptions;
                                                                                                                                                                                                                                                                                                                                                      authSession: string;
                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  Index
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                  authnParamsPublicKey: PasskeyCreationOptions
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                  authSession: string
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/PasswordAuthenticationMethod.html b/docs/interfaces/PasswordAuthenticationMethod.html index 12bfb772..835cc33f 100644 --- a/docs/interfaces/PasswordAuthenticationMethod.html +++ b/docs/interfaces/PasswordAuthenticationMethod.html @@ -1,656 +1,93 @@ - - - - - - PasswordAuthenticationMethod | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                  - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                                                                                                                                    Interface PasswordAuthenticationMethod

                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                    - interface - PasswordAuthenticationMethod - {
                                                                                                                                                                                                                                                                                                                                                        created_at: - string;
                                                                                                                                                                                                                                                                                                                                                        id: - string;
                                                                                                                                                                                                                                                                                                                                                        identity_user_id: - string;
                                                                                                                                                                                                                                                                                                                                                        last_password_reset?: - string;
                                                                                                                                                                                                                                                                                                                                                        type: - "password";
                                                                                                                                                                                                                                                                                                                                                        usage: ("primary" - | - "secondary")[];
                                                                                                                                                                                                                                                                                                                                                    } -
                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • - AuthenticationMethodBase -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • - PasswordAuthenticationMethod -
                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                                                                                                                                                    Index
                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                    - - -

                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                    - created_at: - string -
                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                    - id: - string -
                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                    - identity_user_id: - string -
                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                    - last_password_reset?: - string -
                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                    - type: - "password" -
                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                    - usage: ("primary" - | - "secondary")[] -
                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                    - - +PasswordAuthenticationMethod | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                      Interface PasswordAuthenticationMethod

                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      interface PasswordAuthenticationMethod {
                                                                                                                                                                                                                                                                                                                                                          created_at: string;
                                                                                                                                                                                                                                                                                                                                                          id: string;
                                                                                                                                                                                                                                                                                                                                                          identity_user_id: string;
                                                                                                                                                                                                                                                                                                                                                          last_password_reset?: string;
                                                                                                                                                                                                                                                                                                                                                          type: "password";
                                                                                                                                                                                                                                                                                                                                                          usage: ("primary" | "secondary")[];
                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                      • AuthenticationMethodBase +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                        • PasswordAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      Index
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                      created_at: string
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                      id: string
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                      identity_user_id: string
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                      last_password_reset?: string
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                      type: "password"
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                      usage: ("primary" | "secondary")[]
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/PasswordEnrollmentChallengeOptions.html b/docs/interfaces/PasswordEnrollmentChallengeOptions.html index 7a85603b..18f8ee97 100644 --- a/docs/interfaces/PasswordEnrollmentChallengeOptions.html +++ b/docs/interfaces/PasswordEnrollmentChallengeOptions.html @@ -1,4 +1,66 @@ -PasswordEnrollmentChallengeOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                      @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                        Interface PasswordEnrollmentChallengeOptions

                                                                                                                                                                                                                                                                                                                                                        interface PasswordEnrollmentChallengeOptions {
                                                                                                                                                                                                                                                                                                                                                            connection?: string;
                                                                                                                                                                                                                                                                                                                                                            identity_user_id?: string;
                                                                                                                                                                                                                                                                                                                                                            type: "password";
                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                        connection? +PasswordEnrollmentChallengeOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                          Interface PasswordEnrollmentChallengeOptions

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          interface PasswordEnrollmentChallengeOptions {
                                                                                                                                                                                                                                                                                                                                                              connection?: string;
                                                                                                                                                                                                                                                                                                                                                              identity_user_id?: string;
                                                                                                                                                                                                                                                                                                                                                              type: "password";
                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Index
                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                          connection?: string
                                                                                                                                                                                                                                                                                                                                                          identity_user_id?: string
                                                                                                                                                                                                                                                                                                                                                          type: "password"
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                          connection?: string
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                          identity_user_id?: string
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                          type: "password"
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/PasswordEnrollmentChallengeResponse.html b/docs/interfaces/PasswordEnrollmentChallengeResponse.html index 1c572f14..7bc29d43 100644 --- a/docs/interfaces/PasswordEnrollmentChallengeResponse.html +++ b/docs/interfaces/PasswordEnrollmentChallengeResponse.html @@ -1,605 +1,87 @@ - - - - - - PasswordEnrollmentChallengeResponse | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                          - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                            - -

                                                                                                                                                                                                                                                                                                                                                            Interface PasswordEnrollmentChallengeResponse

                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                            - interface - PasswordEnrollmentChallengeResponse - {
                                                                                                                                                                                                                                                                                                                                                                auth_session: - string;
                                                                                                                                                                                                                                                                                                                                                                id: - string;
                                                                                                                                                                                                                                                                                                                                                                location: - string;
                                                                                                                                                                                                                                                                                                                                                                policy: - PasswordPolicy;
                                                                                                                                                                                                                                                                                                                                                                type: - "password";
                                                                                                                                                                                                                                                                                                                                                            } -
                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                            • - EnrollmentChallengeBaseResponse -
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                              • - PasswordEnrollmentChallengeResponse -
                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                            - - -
                                                                                                                                                                                                                                                                                                                                                            Index
                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                            - - -

                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                            - auth_session: - string -
                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                            - id: - string -
                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                            - location: - string -
                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                            - policy: - PasswordPolicy -
                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                            - type: - "password" -
                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                            - - -
                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                            - - +PasswordEnrollmentChallengeResponse | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                              Interface PasswordEnrollmentChallengeResponse

                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              interface PasswordEnrollmentChallengeResponse {
                                                                                                                                                                                                                                                                                                                                                                  auth_session: string;
                                                                                                                                                                                                                                                                                                                                                                  id: string;
                                                                                                                                                                                                                                                                                                                                                                  location: string;
                                                                                                                                                                                                                                                                                                                                                                  policy: PasswordPolicy;
                                                                                                                                                                                                                                                                                                                                                                  type: "password";
                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                              • EnrollmentChallengeBaseResponse +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                • PasswordEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              Index
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                              auth_session: string
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                              id: string
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                              location: string
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                              policy: PasswordPolicy
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                              type: "password"
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/PasswordEnrollmentVerifyOptions.html b/docs/interfaces/PasswordEnrollmentVerifyOptions.html index 7298dd4a..239d7a03 100644 --- a/docs/interfaces/PasswordEnrollmentVerifyOptions.html +++ b/docs/interfaces/PasswordEnrollmentVerifyOptions.html @@ -1,553 +1,80 @@ - - - - - - PasswordEnrollmentVerifyOptions | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                              - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                - -

                                                                                                                                                                                                                                                                                                                                                                Interface PasswordEnrollmentVerifyOptions

                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                - interface - PasswordEnrollmentVerifyOptions - {
                                                                                                                                                                                                                                                                                                                                                                    auth_session: - string;
                                                                                                                                                                                                                                                                                                                                                                    location: - string;
                                                                                                                                                                                                                                                                                                                                                                    new_password: - string;
                                                                                                                                                                                                                                                                                                                                                                    type: - "password";
                                                                                                                                                                                                                                                                                                                                                                } -
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                • - EnrollmentVerifyBaseOptions -
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                  • - PasswordEnrollmentVerifyOptions -
                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                - - -
                                                                                                                                                                                                                                                                                                                                                                Index
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                - - -

                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                - auth_session: - string -
                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                - location: - string -
                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                - new_password: - string -
                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                - type: - "password" -
                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                - - -
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                - - +PasswordEnrollmentVerifyOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                                                  Interface PasswordEnrollmentVerifyOptions

                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  interface PasswordEnrollmentVerifyOptions {
                                                                                                                                                                                                                                                                                                                                                                      auth_session: string;
                                                                                                                                                                                                                                                                                                                                                                      location: string;
                                                                                                                                                                                                                                                                                                                                                                      new_password: string;
                                                                                                                                                                                                                                                                                                                                                                      type: "password";
                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                  • EnrollmentVerifyBaseOptions +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                    • PasswordEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  Index
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                  auth_session: string
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                  location: string
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                  new_password: string
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                  type: "password"
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/PhoneAuthenticationMethod.html b/docs/interfaces/PhoneAuthenticationMethod.html index cda9b868..8845cdfb 100644 --- a/docs/interfaces/PhoneAuthenticationMethod.html +++ b/docs/interfaces/PhoneAuthenticationMethod.html @@ -1,833 +1,114 @@ - - - - - - PhoneAuthenticationMethod | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                                                                                                                                                    Interface PhoneAuthenticationMethod

                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    - interface - PhoneAuthenticationMethod - {
                                                                                                                                                                                                                                                                                                                                                                        confirmed: - boolean;
                                                                                                                                                                                                                                                                                                                                                                        created_at: - string;
                                                                                                                                                                                                                                                                                                                                                                        id: - string;
                                                                                                                                                                                                                                                                                                                                                                        last_auth_at?: - string;
                                                                                                                                                                                                                                                                                                                                                                        name?: - string;
                                                                                                                                                                                                                                                                                                                                                                        phone_number: - string;
                                                                                                                                                                                                                                                                                                                                                                        preferred_authentication_method: - "sms" - | - "voice";
                                                                                                                                                                                                                                                                                                                                                                        type: - "phone";
                                                                                                                                                                                                                                                                                                                                                                        usage: ("primary" - | - "secondary")[];
                                                                                                                                                                                                                                                                                                                                                                    } -
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                    • - AuthenticationMethodWithMetadata -
                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                      • - PhoneAuthenticationMethod -
                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                                                                                                                                                                    Index
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    - - -

                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                    - confirmed: - boolean -
                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                    - created_at: - string -
                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                    - id: - string -
                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                    - last_auth_at?: - string -
                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                    - name?: - string -
                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                    - phone_number: - string -
                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                    - preferred_authentication_method: - "sms" - | - "voice" -
                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                    - type: - "phone" -
                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                    - usage: ("primary" - | - "secondary")[] -
                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    - - +PhoneAuthenticationMethod | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                                      Interface PhoneAuthenticationMethod

                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      interface PhoneAuthenticationMethod {
                                                                                                                                                                                                                                                                                                                                                                          confirmed: boolean;
                                                                                                                                                                                                                                                                                                                                                                          created_at: string;
                                                                                                                                                                                                                                                                                                                                                                          id: string;
                                                                                                                                                                                                                                                                                                                                                                          last_auth_at?: string;
                                                                                                                                                                                                                                                                                                                                                                          name?: string;
                                                                                                                                                                                                                                                                                                                                                                          phone_number: string;
                                                                                                                                                                                                                                                                                                                                                                          preferred_authentication_method: "sms" | "voice";
                                                                                                                                                                                                                                                                                                                                                                          type: "phone";
                                                                                                                                                                                                                                                                                                                                                                          usage: ("primary" | "secondary")[];
                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                      • AuthenticationMethodWithMetadata +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                        • PhoneAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      Index
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                      confirmed: boolean
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                      created_at: string
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                      id: string
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                      last_auth_at?: string
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                      name?: string
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                      phone_number: string
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                      preferred_authentication_method: "sms" | "voice"
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                      type: "phone"
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                      usage: ("primary" | "secondary")[]
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/PhoneEnrollmentChallengeOptions.html b/docs/interfaces/PhoneEnrollmentChallengeOptions.html index 744a77b5..9f73f116 100644 --- a/docs/interfaces/PhoneEnrollmentChallengeOptions.html +++ b/docs/interfaces/PhoneEnrollmentChallengeOptions.html @@ -1,4 +1,66 @@ -PhoneEnrollmentChallengeOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                      @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                        Interface PhoneEnrollmentChallengeOptions

                                                                                                                                                                                                                                                                                                                                                                        interface PhoneEnrollmentChallengeOptions {
                                                                                                                                                                                                                                                                                                                                                                            phone_number: string;
                                                                                                                                                                                                                                                                                                                                                                            preferred_authentication_method?: "sms" | "voice";
                                                                                                                                                                                                                                                                                                                                                                            type: "phone";
                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                        phone_number +PhoneEnrollmentChallengeOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                                          Interface PhoneEnrollmentChallengeOptions

                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          interface PhoneEnrollmentChallengeOptions {
                                                                                                                                                                                                                                                                                                                                                                              phone_number: string;
                                                                                                                                                                                                                                                                                                                                                                              preferred_authentication_method?: "sms" | "voice";
                                                                                                                                                                                                                                                                                                                                                                              type: "phone";
                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          Index
                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                          phone_number: string
                                                                                                                                                                                                                                                                                                                                                                          preferred_authentication_method?: "sms" | "voice"
                                                                                                                                                                                                                                                                                                                                                                          type: "phone"
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                          phone_number: string
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                          preferred_authentication_method?: "sms" | "voice"
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                          type: "phone"
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/PhoneEnrollmentChallengeResponse.html b/docs/interfaces/PhoneEnrollmentChallengeResponse.html index af1bb843..f5396048 100644 --- a/docs/interfaces/PhoneEnrollmentChallengeResponse.html +++ b/docs/interfaces/PhoneEnrollmentChallengeResponse.html @@ -1,557 +1,81 @@ - - - - - - PhoneEnrollmentChallengeResponse | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                          - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            - -

                                                                                                                                                                                                                                                                                                                                                                            Interface PhoneEnrollmentChallengeResponse

                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            - interface - PhoneEnrollmentChallengeResponse - {
                                                                                                                                                                                                                                                                                                                                                                                auth_session: - string;
                                                                                                                                                                                                                                                                                                                                                                                id: - string;
                                                                                                                                                                                                                                                                                                                                                                                location: - string;
                                                                                                                                                                                                                                                                                                                                                                                type: - "phone";
                                                                                                                                                                                                                                                                                                                                                                            } -
                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                            • - EnrollmentChallengeBaseResponse -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                              • - PhoneEnrollmentChallengeResponse -
                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            - - -
                                                                                                                                                                                                                                                                                                                                                                            Index
                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            - - -

                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                            - auth_session: - string -
                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                            - id: - string -
                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                            - location: - string -
                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                            - type: - "phone" -
                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            - - -
                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            - - +PhoneEnrollmentChallengeResponse | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                                              Interface PhoneEnrollmentChallengeResponse

                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              interface PhoneEnrollmentChallengeResponse {
                                                                                                                                                                                                                                                                                                                                                                                  auth_session: string;
                                                                                                                                                                                                                                                                                                                                                                                  id: string;
                                                                                                                                                                                                                                                                                                                                                                                  location: string;
                                                                                                                                                                                                                                                                                                                                                                                  type: "phone";
                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                              • EnrollmentChallengeBaseResponse +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                • PhoneEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              Index
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                              auth_session: string
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                              id: string
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                              location: string
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                              type: "phone"
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/PhoneEnrollmentVerifyOptions.html b/docs/interfaces/PhoneEnrollmentVerifyOptions.html index 5796ba18..b49a9dd9 100644 --- a/docs/interfaces/PhoneEnrollmentVerifyOptions.html +++ b/docs/interfaces/PhoneEnrollmentVerifyOptions.html @@ -1,549 +1,80 @@ - - - - - - PhoneEnrollmentVerifyOptions | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                              - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                - -

                                                                                                                                                                                                                                                                                                                                                                                Interface PhoneEnrollmentVerifyOptions

                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                - interface - PhoneEnrollmentVerifyOptions - {
                                                                                                                                                                                                                                                                                                                                                                                    auth_session: - string;
                                                                                                                                                                                                                                                                                                                                                                                    location: - string;
                                                                                                                                                                                                                                                                                                                                                                                    otp_code: - string;
                                                                                                                                                                                                                                                                                                                                                                                    type: - "phone";
                                                                                                                                                                                                                                                                                                                                                                                } -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                • - EnrollmentVerifyBaseOptions -
                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                  • - PhoneEnrollmentVerifyOptions -
                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                - - -
                                                                                                                                                                                                                                                                                                                                                                                Index
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                - - -

                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                - auth_session: - string -
                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                - location: - string -
                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                - otp_code: - string -
                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                - type: - "phone" -
                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                - - -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                - - +PhoneEnrollmentVerifyOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                                                                  Interface PhoneEnrollmentVerifyOptions

                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  interface PhoneEnrollmentVerifyOptions {
                                                                                                                                                                                                                                                                                                                                                                                      auth_session: string;
                                                                                                                                                                                                                                                                                                                                                                                      location: string;
                                                                                                                                                                                                                                                                                                                                                                                      otp_code: string;
                                                                                                                                                                                                                                                                                                                                                                                      type: "phone";
                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                  • EnrollmentVerifyBaseOptions +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                    • PhoneEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  Index
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                  auth_session: string
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                  location: string
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                  otp_code: string
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                  type: "phone"
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/PopupConfigOptions.html b/docs/interfaces/PopupConfigOptions.html index 91391163..0ab2204a 100644 --- a/docs/interfaces/PopupConfigOptions.html +++ b/docs/interfaces/PopupConfigOptions.html @@ -1,7 +1,36 @@ -PopupConfigOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                  @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                    Interface PopupConfigOptions

                                                                                                                                                                                                                                                                                                                                                                                    interface PopupConfigOptions {
                                                                                                                                                                                                                                                                                                                                                                                        closePopup?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                        popup?: any;
                                                                                                                                                                                                                                                                                                                                                                                        timeoutInSeconds?: number;
                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                    closePopup? +PopupConfigOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                                                      Interface PopupConfigOptions

                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      interface PopupConfigOptions {
                                                                                                                                                                                                                                                                                                                                                                                          closePopup?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                          popup?: any;
                                                                                                                                                                                                                                                                                                                                                                                          timeoutInSeconds?: number;
                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      Index
                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      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

                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/PopupLoginOptions.html b/docs/interfaces/PopupLoginOptions.html index 8ddd528d..90098712 100644 --- a/docs/interfaces/PopupLoginOptions.html +++ b/docs/interfaces/PopupLoginOptions.html @@ -1,4 +1,66 @@ -PopupLoginOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                      @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                        Interface PopupLoginOptions

                                                                                                                                                                                                                                                                                                                                                                                        interface PopupLoginOptions {
                                                                                                                                                                                                                                                                                                                                                                                            authorizationParams?: AuthorizationParams;
                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                        authorizationParams?: AuthorizationParams

                                                                                                                                                                                                                                                                                                                                                                                        URL parameters that will be sent back to the Authorization Server. This can be known parameters +PopupLoginOptions | @auth0/auth0-angular

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

                                                                                                                                                                                                                                                                                                                                                                                          Interface PopupLoginOptions

                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          interface PopupLoginOptions {
                                                                                                                                                                                                                                                                                                                                                                                              authorizationParams?: AuthorizationParams;
                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          Index
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                          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.

                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/PushNotificationAuthenticationMethod.html b/docs/interfaces/PushNotificationAuthenticationMethod.html index 16f4af82..9c5bda7e 100644 --- a/docs/interfaces/PushNotificationAuthenticationMethod.html +++ b/docs/interfaces/PushNotificationAuthenticationMethod.html @@ -1,728 +1,102 @@ - - - - - - PushNotificationAuthenticationMethod | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                          - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            - -

                                                                                                                                                                                                                                                                                                                                                                                            Interface PushNotificationAuthenticationMethod

                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            - interface - PushNotificationAuthenticationMethod - {
                                                                                                                                                                                                                                                                                                                                                                                                confirmed: - boolean;
                                                                                                                                                                                                                                                                                                                                                                                                created_at: - string;
                                                                                                                                                                                                                                                                                                                                                                                                id: - string;
                                                                                                                                                                                                                                                                                                                                                                                                last_auth_at?: - string;
                                                                                                                                                                                                                                                                                                                                                                                                name?: - string;
                                                                                                                                                                                                                                                                                                                                                                                                type: - "push-notification";
                                                                                                                                                                                                                                                                                                                                                                                                usage: ("primary" - | - "secondary")[];
                                                                                                                                                                                                                                                                                                                                                                                            } -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                            • - AuthenticationMethodWithMetadata -
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                              • - PushNotificationAuthenticationMethod -
                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            - - -
                                                                                                                                                                                                                                                                                                                                                                                            Index
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            - - -

                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                            - confirmed: - boolean -
                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                            - created_at: - string -
                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                            - id: - string -
                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                            - last_auth_at?: - string -
                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                            - name?: - string -
                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                            - type: - "push-notification" -
                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                            - usage: ("primary" - | - "secondary")[] -
                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            - - -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            - - +PushNotificationAuthenticationMethod | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                                                              Interface PushNotificationAuthenticationMethod

                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              interface PushNotificationAuthenticationMethod {
                                                                                                                                                                                                                                                                                                                                                                                                  confirmed: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                  created_at: string;
                                                                                                                                                                                                                                                                                                                                                                                                  id: string;
                                                                                                                                                                                                                                                                                                                                                                                                  last_auth_at?: string;
                                                                                                                                                                                                                                                                                                                                                                                                  name?: string;
                                                                                                                                                                                                                                                                                                                                                                                                  type: "push-notification";
                                                                                                                                                                                                                                                                                                                                                                                                  usage: ("primary" | "secondary")[];
                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                              • AuthenticationMethodWithMetadata +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                • PushNotificationAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              Index
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                              confirmed: boolean
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                              created_at: string
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                              id: string
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                              last_auth_at?: string
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                              name?: string
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                              type: "push-notification"
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                              usage: ("primary" | "secondary")[]
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/PushNotificationEnrollmentChallengeOptions.html b/docs/interfaces/PushNotificationEnrollmentChallengeOptions.html index b85c7824..900b2825 100644 --- a/docs/interfaces/PushNotificationEnrollmentChallengeOptions.html +++ b/docs/interfaces/PushNotificationEnrollmentChallengeOptions.html @@ -1,2 +1,54 @@ -PushNotificationEnrollmentChallengeOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                              @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                Interface PushNotificationEnrollmentChallengeOptions

                                                                                                                                                                                                                                                                                                                                                                                                interface PushNotificationEnrollmentChallengeOptions {
                                                                                                                                                                                                                                                                                                                                                                                                    type: "push-notification";
                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                type: "push-notification"
                                                                                                                                                                                                                                                                                                                                                                                                +PushNotificationEnrollmentChallengeOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                                                                                  Interface PushNotificationEnrollmentChallengeOptions

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  interface PushNotificationEnrollmentChallengeOptions {
                                                                                                                                                                                                                                                                                                                                                                                                      type: "push-notification";
                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  Index
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                  type: "push-notification"
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/PushNotificationEnrollmentChallengeResponse.html b/docs/interfaces/PushNotificationEnrollmentChallengeResponse.html index 2cece345..a4310e77 100644 --- a/docs/interfaces/PushNotificationEnrollmentChallengeResponse.html +++ b/docs/interfaces/PushNotificationEnrollmentChallengeResponse.html @@ -1,662 +1,93 @@ - - - - - - - PushNotificationEnrollmentChallengeResponse | @auth0/auth0-angular - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                                                                                                                                                                                    Interface PushNotificationEnrollmentChallengeResponse

                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    - interface - PushNotificationEnrollmentChallengeResponse - {
                                                                                                                                                                                                                                                                                                                                                                                                        auth_session: - string;
                                                                                                                                                                                                                                                                                                                                                                                                        barcode_uri: - string;
                                                                                                                                                                                                                                                                                                                                                                                                        id: - string;
                                                                                                                                                                                                                                                                                                                                                                                                        location: - string;
                                                                                                                                                                                                                                                                                                                                                                                                        manual_input_code?: - string;
                                                                                                                                                                                                                                                                                                                                                                                                        type: - "push-notification";
                                                                                                                                                                                                                                                                                                                                                                                                    } -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                    • - EnrollmentChallengeBaseResponse -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                      • - PushNotificationEnrollmentChallengeResponse -
                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                                                                                                                                                                                                    Index
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    - - -

                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                    - auth_session: - string -
                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                    - barcode_uri: - string -
                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                    - id: - string -
                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                    - location: - string -
                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                    - manual_input_code?: - string -
                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                    - type: - "push-notification" -
                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    - - +PushNotificationEnrollmentChallengeResponse | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                                                                      Interface PushNotificationEnrollmentChallengeResponse

                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      interface PushNotificationEnrollmentChallengeResponse {
                                                                                                                                                                                                                                                                                                                                                                                                          auth_session: string;
                                                                                                                                                                                                                                                                                                                                                                                                          barcode_uri: string;
                                                                                                                                                                                                                                                                                                                                                                                                          id: string;
                                                                                                                                                                                                                                                                                                                                                                                                          location: string;
                                                                                                                                                                                                                                                                                                                                                                                                          manual_input_code?: string;
                                                                                                                                                                                                                                                                                                                                                                                                          type: "push-notification";
                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                      • EnrollmentChallengeBaseResponse +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                        • PushNotificationEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      Index
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                      auth_session: string
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                      barcode_uri: string
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                      id: string
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                      location: string
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                      manual_input_code?: string
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                      type: "push-notification"
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/PushNotificationEnrollmentVerifyOptions.html b/docs/interfaces/PushNotificationEnrollmentVerifyOptions.html index 3ca59c93..46bc043b 100644 --- a/docs/interfaces/PushNotificationEnrollmentVerifyOptions.html +++ b/docs/interfaces/PushNotificationEnrollmentVerifyOptions.html @@ -1,509 +1,74 @@ - - - - - - - PushNotificationEnrollmentVerifyOptions | @auth0/auth0-angular - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        - -

                                                                                                                                                                                                                                                                                                                                                                                                        Interface PushNotificationEnrollmentVerifyOptions

                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        - interface - PushNotificationEnrollmentVerifyOptions - {
                                                                                                                                                                                                                                                                                                                                                                                                            auth_session: - string;
                                                                                                                                                                                                                                                                                                                                                                                                            location: - string;
                                                                                                                                                                                                                                                                                                                                                                                                            type: - "push-notification";
                                                                                                                                                                                                                                                                                                                                                                                                        } -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                        • - EnrollmentVerifyBaseOptions -
                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                          • - PushNotificationEnrollmentVerifyOptions -
                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        - - -
                                                                                                                                                                                                                                                                                                                                                                                                        Index
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        - - -

                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                                                                                        - auth_session: - string -
                                                                                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                                                                                        - location: - string -
                                                                                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                                                                                        - type: - "push-notification" -
                                                                                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        - - -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        - - +PushNotificationEnrollmentVerifyOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                                                                          Interface PushNotificationEnrollmentVerifyOptions

                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          interface PushNotificationEnrollmentVerifyOptions {
                                                                                                                                                                                                                                                                                                                                                                                                              auth_session: string;
                                                                                                                                                                                                                                                                                                                                                                                                              location: string;
                                                                                                                                                                                                                                                                                                                                                                                                              type: "push-notification";
                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                          • EnrollmentVerifyBaseOptions +
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                            • PushNotificationEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          Index
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                          auth_session: string
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                          location: string
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                          type: "push-notification"
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/RecoveryCodeAuthenticationMethod.html b/docs/interfaces/RecoveryCodeAuthenticationMethod.html index 6c600167..cf2b4033 100644 --- a/docs/interfaces/RecoveryCodeAuthenticationMethod.html +++ b/docs/interfaces/RecoveryCodeAuthenticationMethod.html @@ -1,711 +1,95 @@ - - - - - - RecoveryCodeAuthenticationMethod | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                          - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            - -

                                                                                                                                                                                                                                                                                                                                                                                                            Interface RecoveryCodeAuthenticationMethod

                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            - interface - RecoveryCodeAuthenticationMethod - {
                                                                                                                                                                                                                                                                                                                                                                                                                confirmed: - boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                created_at: - string;
                                                                                                                                                                                                                                                                                                                                                                                                                id: - string;
                                                                                                                                                                                                                                                                                                                                                                                                                last_auth_at?: - string;
                                                                                                                                                                                                                                                                                                                                                                                                                type: - "recovery-code";
                                                                                                                                                                                                                                                                                                                                                                                                                usage: ("primary" - | - "secondary")[];
                                                                                                                                                                                                                                                                                                                                                                                                            } -
                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                            • - Omit<AuthenticationMethodWithMetadata, - "name"> -
                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                              • - RecoveryCodeAuthenticationMethod -
                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            - - -
                                                                                                                                                                                                                                                                                                                                                                                                            Index
                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            - - -

                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                            - confirmed: - boolean -
                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                            - created_at: - string -
                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                            - id: - string -
                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                            - last_auth_at?: - string -
                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                            - type: - "recovery-code" -
                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                            - usage: ("primary" - | - "secondary")[] -
                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            - - -
                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            - - +RecoveryCodeAuthenticationMethod | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                                                                              Interface RecoveryCodeAuthenticationMethod

                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              interface RecoveryCodeAuthenticationMethod {
                                                                                                                                                                                                                                                                                                                                                                                                                  confirmed: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                  created_at: string;
                                                                                                                                                                                                                                                                                                                                                                                                                  id: string;
                                                                                                                                                                                                                                                                                                                                                                                                                  last_auth_at?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                  type: "recovery-code";
                                                                                                                                                                                                                                                                                                                                                                                                                  usage: ("primary" | "secondary")[];
                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                              • Omit<AuthenticationMethodWithMetadata, "name"> +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                • RecoveryCodeAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              Index
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                              confirmed: boolean
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                              created_at: string
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                              id: string
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                              last_auth_at?: string
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                              type: "recovery-code"
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                              usage: ("primary" | "secondary")[]
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/RecoveryCodeEnrollmentChallengeOptions.html b/docs/interfaces/RecoveryCodeEnrollmentChallengeOptions.html index c6b59529..47e532e6 100644 --- a/docs/interfaces/RecoveryCodeEnrollmentChallengeOptions.html +++ b/docs/interfaces/RecoveryCodeEnrollmentChallengeOptions.html @@ -1,2 +1,54 @@ -RecoveryCodeEnrollmentChallengeOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                              @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                Interface RecoveryCodeEnrollmentChallengeOptions

                                                                                                                                                                                                                                                                                                                                                                                                                interface RecoveryCodeEnrollmentChallengeOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                    type: "recovery-code";
                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                type: "recovery-code"
                                                                                                                                                                                                                                                                                                                                                                                                                +RecoveryCodeEnrollmentChallengeOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                                                                                                  Interface RecoveryCodeEnrollmentChallengeOptions

                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  interface RecoveryCodeEnrollmentChallengeOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                      type: "recovery-code";
                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  Index
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                  type: "recovery-code"
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/RecoveryCodeEnrollmentChallengeResponse.html b/docs/interfaces/RecoveryCodeEnrollmentChallengeResponse.html index a6aaa090..fb7cb3f0 100644 --- a/docs/interfaces/RecoveryCodeEnrollmentChallengeResponse.html +++ b/docs/interfaces/RecoveryCodeEnrollmentChallengeResponse.html @@ -1,611 +1,87 @@ - - - - - - - RecoveryCodeEnrollmentChallengeResponse | @auth0/auth0-angular - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                  - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                                                                                                                                                                                                    Interface RecoveryCodeEnrollmentChallengeResponse

                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                    - interface - RecoveryCodeEnrollmentChallengeResponse - {
                                                                                                                                                                                                                                                                                                                                                                                                                        auth_session: - string;
                                                                                                                                                                                                                                                                                                                                                                                                                        id: - string;
                                                                                                                                                                                                                                                                                                                                                                                                                        location: - string;
                                                                                                                                                                                                                                                                                                                                                                                                                        recovery_code: - string;
                                                                                                                                                                                                                                                                                                                                                                                                                        type: - "recovery-code";
                                                                                                                                                                                                                                                                                                                                                                                                                    } -
                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                    • - EnrollmentChallengeBaseResponse -
                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                      • - RecoveryCodeEnrollmentChallengeResponse -
                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                                                                                                                                                                                                                    Index
                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                    - - -

                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                                    - auth_session: - string -
                                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                                    - id: - string -
                                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                                    - location: - string -
                                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                                    - recovery_code: - string -
                                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                                    - type: - "recovery-code" -
                                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                    - - +RecoveryCodeEnrollmentChallengeResponse | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                                                                                      Interface RecoveryCodeEnrollmentChallengeResponse

                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      interface RecoveryCodeEnrollmentChallengeResponse {
                                                                                                                                                                                                                                                                                                                                                                                                                          auth_session: string;
                                                                                                                                                                                                                                                                                                                                                                                                                          id: string;
                                                                                                                                                                                                                                                                                                                                                                                                                          location: string;
                                                                                                                                                                                                                                                                                                                                                                                                                          recovery_code: string;
                                                                                                                                                                                                                                                                                                                                                                                                                          type: "recovery-code";
                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                      • EnrollmentChallengeBaseResponse +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                        • RecoveryCodeEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      Index
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                      auth_session: string
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                      id: string
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                      location: string
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                      recovery_code: string
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                      type: "recovery-code"
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/RecoveryCodeEnrollmentVerifyOptions.html b/docs/interfaces/RecoveryCodeEnrollmentVerifyOptions.html index 4397cfe7..9711b8e9 100644 --- a/docs/interfaces/RecoveryCodeEnrollmentVerifyOptions.html +++ b/docs/interfaces/RecoveryCodeEnrollmentVerifyOptions.html @@ -1,507 +1,74 @@ - - - - - - RecoveryCodeEnrollmentVerifyOptions | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                        - -

                                                                                                                                                                                                                                                                                                                                                                                                                        Interface RecoveryCodeEnrollmentVerifyOptions

                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                        - interface - RecoveryCodeEnrollmentVerifyOptions - {
                                                                                                                                                                                                                                                                                                                                                                                                                            auth_session: - string;
                                                                                                                                                                                                                                                                                                                                                                                                                            location: - string;
                                                                                                                                                                                                                                                                                                                                                                                                                            type: - "recovery-code";
                                                                                                                                                                                                                                                                                                                                                                                                                        } -
                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                        • - EnrollmentVerifyBaseOptions -
                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                          • - RecoveryCodeEnrollmentVerifyOptions -
                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                        - - -
                                                                                                                                                                                                                                                                                                                                                                                                                        Index
                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                        - - -

                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                                                                                                        - auth_session: - string -
                                                                                                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                                                                                                        - location: - string -
                                                                                                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                                                                                                        - type: - "recovery-code" -
                                                                                                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                        - - -
                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                        - - +RecoveryCodeEnrollmentVerifyOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                                                                                          Interface RecoveryCodeEnrollmentVerifyOptions

                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          interface RecoveryCodeEnrollmentVerifyOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                              auth_session: string;
                                                                                                                                                                                                                                                                                                                                                                                                                              location: string;
                                                                                                                                                                                                                                                                                                                                                                                                                              type: "recovery-code";
                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                          • EnrollmentVerifyBaseOptions +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                            • RecoveryCodeEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          Index
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                          auth_session: string
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                          location: string
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                          type: "recovery-code"
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/RedirectConnectAccountOptions.html b/docs/interfaces/RedirectConnectAccountOptions.html index c8d681a7..b4c48a5a 100644 --- a/docs/interfaces/RedirectConnectAccountOptions.html +++ b/docs/interfaces/RedirectConnectAccountOptions.html @@ -1,25 +1,124 @@ -RedirectConnectAccountOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                          @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                            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-angular
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              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?: 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']
                                                                                                                                                                                                                                                                                                                                                                                                                              });
                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/RedirectLoginOptions.html b/docs/interfaces/RedirectLoginOptions.html index a8403f94..e754478a 100644 --- a/docs/interfaces/RedirectLoginOptions.html +++ b/docs/interfaces/RedirectLoginOptions.html @@ -1,676 +1,106 @@ - - - - - - RedirectLoginOptions | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                              - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                - -

                                                                                                                                                                                                                                                                                                                                                                                                                                Interface RedirectLoginOptions<TAppState>

                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                - interface - RedirectLoginOptions<TAppState> - {
                                                                                                                                                                                                                                                                                                                                                                                                                                    appState?: - TAppState;
                                                                                                                                                                                                                                                                                                                                                                                                                                    authorizationParams?: - AuthorizationParams;
                                                                                                                                                                                                                                                                                                                                                                                                                                    fragment?: - string;
                                                                                                                                                                                                                                                                                                                                                                                                                                    openUrl?: - (url: - string) - => - void - | - Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                } -
                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                • - TAppState -
                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                • - Omit<SPARedirectLoginOptions<TAppState>, - "onRedirect"> -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                  • - RedirectLoginOptions -
                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                Index
                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                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 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);
                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                }); +RedirectLoginOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface RedirectLoginOptions<TAppState>

                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  interface RedirectLoginOptions<TAppState> {
                                                                                                                                                                                                                                                                                                                                                                                                                                      appState?: TAppState;
                                                                                                                                                                                                                                                                                                                                                                                                                                      authorizationParams?: AuthorizationParams;
                                                                                                                                                                                                                                                                                                                                                                                                                                      fragment?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                      openUrl?: (url: string) => void | Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                  • TAppState
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                  • Omit<SPARedirectLoginOptions<TAppState>, "onRedirect"> +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                    • RedirectLoginOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  Index
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                  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);
                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                  });
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  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 });
                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                  });
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - + +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/TotpAuthenticationMethod.html b/docs/interfaces/TotpAuthenticationMethod.html index f1feebfe..9622fc4a 100644 --- a/docs/interfaces/TotpAuthenticationMethod.html +++ b/docs/interfaces/TotpAuthenticationMethod.html @@ -1,720 +1,102 @@ - - - - - - TotpAuthenticationMethod | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface TotpAuthenticationMethod

                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    - interface - TotpAuthenticationMethod - {
                                                                                                                                                                                                                                                                                                                                                                                                                                        confirmed: - boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                        created_at: - string;
                                                                                                                                                                                                                                                                                                                                                                                                                                        id: - string;
                                                                                                                                                                                                                                                                                                                                                                                                                                        last_auth_at?: - string;
                                                                                                                                                                                                                                                                                                                                                                                                                                        name?: - string;
                                                                                                                                                                                                                                                                                                                                                                                                                                        type: - "totp";
                                                                                                                                                                                                                                                                                                                                                                                                                                        usage: ("primary" - | - "secondary")[];
                                                                                                                                                                                                                                                                                                                                                                                                                                    } -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                    • - AuthenticationMethodWithMetadata -
                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                      • - TotpAuthenticationMethod -
                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    Index
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    - confirmed: - boolean -
                                                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    - created_at: - string -
                                                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    - id: - string -
                                                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    - last_auth_at?: - string -
                                                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    - name?: - string -
                                                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    - type: - "totp" -
                                                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    - usage: ("primary" - | - "secondary")[] -
                                                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    - - +TotpAuthenticationMethod | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface TotpAuthenticationMethod

                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      interface TotpAuthenticationMethod {
                                                                                                                                                                                                                                                                                                                                                                                                                                          confirmed: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                          created_at: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                          id: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                          last_auth_at?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                          name?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                          type: "totp";
                                                                                                                                                                                                                                                                                                                                                                                                                                          usage: ("primary" | "secondary")[];
                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                      • AuthenticationMethodWithMetadata +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                        • TotpAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      Index
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                      confirmed: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                      created_at: string
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                      id: string
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                      last_auth_at?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                      name?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                      type: "totp"
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                      usage: ("primary" | "secondary")[]
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/TotpEnrollmentChallengeOptions.html b/docs/interfaces/TotpEnrollmentChallengeOptions.html index 3d5ac35d..930090f8 100644 --- a/docs/interfaces/TotpEnrollmentChallengeOptions.html +++ b/docs/interfaces/TotpEnrollmentChallengeOptions.html @@ -1,2 +1,54 @@ -TotpEnrollmentChallengeOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                      @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface TotpEnrollmentChallengeOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                        interface TotpEnrollmentChallengeOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                            type: "totp";
                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                        type: "totp"
                                                                                                                                                                                                                                                                                                                                                                                                                                        +TotpEnrollmentChallengeOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface TotpEnrollmentChallengeOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          interface TotpEnrollmentChallengeOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                              type: "totp";
                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          Index
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                                          type: "totp"
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/TotpEnrollmentChallengeResponse.html b/docs/interfaces/TotpEnrollmentChallengeResponse.html index 41f5b86e..89ae803d 100644 --- a/docs/interfaces/TotpEnrollmentChallengeResponse.html +++ b/docs/interfaces/TotpEnrollmentChallengeResponse.html @@ -1,656 +1,93 @@ - - - - - - TotpEnrollmentChallengeResponse | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                          - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                            - -

                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface TotpEnrollmentChallengeResponse

                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                            - interface - TotpEnrollmentChallengeResponse - {
                                                                                                                                                                                                                                                                                                                                                                                                                                                auth_session: - string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                barcode_uri: - string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                id: - string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                location: - string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                manual_input_code?: - string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                type: - "totp";
                                                                                                                                                                                                                                                                                                                                                                                                                                            } -
                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                            • - EnrollmentChallengeBaseResponse -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                              • - TotpEnrollmentChallengeResponse -
                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                            - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                            Index
                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                            - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                                                            - auth_session: - string -
                                                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                                                            - barcode_uri: - string -
                                                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                                                            - id: - string -
                                                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                                                            - location: - string -
                                                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                                                            - manual_input_code?: - string -
                                                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                                                            - type: - "totp" -
                                                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                            - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                            - - +TotpEnrollmentChallengeResponse | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface TotpEnrollmentChallengeResponse

                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              interface TotpEnrollmentChallengeResponse {
                                                                                                                                                                                                                                                                                                                                                                                                                                                  auth_session: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                  barcode_uri: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                  id: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                  location: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                  manual_input_code?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                  type: "totp";
                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                              • EnrollmentChallengeBaseResponse +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                • TotpEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              Index
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                              auth_session: string
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                              barcode_uri: string
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                              id: string
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                              location: string
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                              manual_input_code?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                              type: "totp"
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/TotpEnrollmentVerifyOptions.html b/docs/interfaces/TotpEnrollmentVerifyOptions.html index 1456b0fa..7879bae6 100644 --- a/docs/interfaces/TotpEnrollmentVerifyOptions.html +++ b/docs/interfaces/TotpEnrollmentVerifyOptions.html @@ -1,549 +1,80 @@ - - - - - - TotpEnrollmentVerifyOptions | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                              - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface TotpEnrollmentVerifyOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - interface - TotpEnrollmentVerifyOptions - {
                                                                                                                                                                                                                                                                                                                                                                                                                                                    auth_session: - string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    location: - string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    otp_code: - string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    type: - "totp";
                                                                                                                                                                                                                                                                                                                                                                                                                                                } -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                • - EnrollmentVerifyBaseOptions -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • - TotpEnrollmentVerifyOptions -
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                Index
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - auth_session: - string -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - location: - string -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - otp_code: - string -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - type: - "totp" -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - - +TotpEnrollmentVerifyOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface TotpEnrollmentVerifyOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface TotpEnrollmentVerifyOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                      auth_session: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      location: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      otp_code: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      type: "totp";
                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • EnrollmentVerifyBaseOptions +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • TotpEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  auth_session: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  location: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  otp_code: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  type: "totp"
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/UpdateAuthenticationMethodRequest.html b/docs/interfaces/UpdateAuthenticationMethodRequest.html index f83409f1..8a7bf162 100644 --- a/docs/interfaces/UpdateAuthenticationMethodRequest.html +++ b/docs/interfaces/UpdateAuthenticationMethodRequest.html @@ -1,4 +1,62 @@ -UpdateAuthenticationMethodRequest | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                  @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface UpdateAuthenticationMethodRequest

                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface UpdateAuthenticationMethodRequest {
                                                                                                                                                                                                                                                                                                                                                                                                                                                        name?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        preferred_authentication_method?: "sms" | "voice";
                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                    name? +UpdateAuthenticationMethodRequest | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface UpdateAuthenticationMethodRequest

                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface UpdateAuthenticationMethodRequest {
                                                                                                                                                                                                                                                                                                                                                                                                                                                          name?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          preferred_authentication_method?: "sms" | "voice";
                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                      name?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                      preferred_authentication_method?: "sms" | "voice"

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Only valid when updating a phone authentication method.

                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      name?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      preferred_authentication_method?: "sms" | "voice"
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Only valid when updating a phone authentication method.

                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/VerifyParams.html b/docs/interfaces/VerifyParams.html index 1ce33c90..bd9cbf06 100644 --- a/docs/interfaces/VerifyParams.html +++ b/docs/interfaces/VerifyParams.html @@ -1,18 +1,97 @@ -VerifyParams | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                      @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface VerifyParams

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters for verifying an MFA challenge.

                                                                                                                                                                                                                                                                                                                                                                                                                                                        +VerifyParams | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          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

                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface VerifyParams {
                                                                                                                                                                                                                                                                                                                                                                                                                                                              bindingCode?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                              mfaToken: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                              oobCode?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                              otp?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                              recoveryCode?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                          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)

                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          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)

                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/WebAuthnPlatformAuthenticationMethod.html b/docs/interfaces/WebAuthnPlatformAuthenticationMethod.html index 413acc7c..185ede55 100644 --- a/docs/interfaces/WebAuthnPlatformAuthenticationMethod.html +++ b/docs/interfaces/WebAuthnPlatformAuthenticationMethod.html @@ -1,839 +1,116 @@ - - - - - - WebAuthnPlatformAuthenticationMethod | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                          - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface WebAuthnPlatformAuthenticationMethod

                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            - interface - WebAuthnPlatformAuthenticationMethod - {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                confirmed: - boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                created_at: - string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                id: - string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                key_id?: - string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                last_auth_at?: - string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                name?: - string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                public_key?: - string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                type: - "webauthn-platform";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                usage: ("primary" - | - "secondary")[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                            } -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • - WebAuthnAuthenticationMethodBase -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                              • - WebAuthnPlatformAuthenticationMethod -
                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index
                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            - confirmed: - boolean -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            - created_at: - string -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            - id: - string -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            - key_id?: - string -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            - last_auth_at?: - string -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            - name?: - string -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            - public_key?: - string -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            - type: - "webauthn-platform" -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            - usage: ("primary" - | - "secondary")[] -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            - - +WebAuthnPlatformAuthenticationMethod | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface WebAuthnPlatformAuthenticationMethod

                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface WebAuthnPlatformAuthenticationMethod {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  confirmed: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  created_at: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  id: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  key_id?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  last_auth_at?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  name?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  public_key?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type: "webauthn-platform";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  usage: ("primary" | "secondary")[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              • WebAuthnAuthenticationMethodBase +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                • WebAuthnPlatformAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              confirmed: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              created_at: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              id: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              key_id?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              last_auth_at?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              name?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              public_key?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              type: "webauthn-platform"
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              usage: ("primary" | "secondary")[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/WebAuthnRoamingAuthenticationMethod.html b/docs/interfaces/WebAuthnRoamingAuthenticationMethod.html index 5d89b12b..19979158 100644 --- a/docs/interfaces/WebAuthnRoamingAuthenticationMethod.html +++ b/docs/interfaces/WebAuthnRoamingAuthenticationMethod.html @@ -1,839 +1,116 @@ - - - - - - WebAuthnRoamingAuthenticationMethod | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                              - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface WebAuthnRoamingAuthenticationMethod

                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                - interface - WebAuthnRoamingAuthenticationMethod - {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    confirmed: - boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    created_at: - string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    id: - string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    key_id?: - string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    last_auth_at?: - string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    name?: - string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    public_key?: - string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    type: - "webauthn-roaming";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    usage: ("primary" - | - "secondary")[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                } -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                • - WebAuthnAuthenticationMethodBase -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • - WebAuthnRoamingAuthenticationMethod -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index
                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                - confirmed: - boolean -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                - created_at: - string -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                - id: - string -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                - key_id?: - string -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                - last_auth_at?: - string -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                - name?: - string -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                - public_key?: - string -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                - type: - "webauthn-roaming" -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                - usage: ("primary" - | - "secondary")[] -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                - - +WebAuthnRoamingAuthenticationMethod | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface WebAuthnRoamingAuthenticationMethod

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface WebAuthnRoamingAuthenticationMethod {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      confirmed: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      created_at: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      id: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      key_id?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      last_auth_at?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      name?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      public_key?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type: "webauthn-roaming";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      usage: ("primary" | "secondary")[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • WebAuthnAuthenticationMethodBase +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • WebAuthnRoamingAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  confirmed: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  created_at: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  id: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  key_id?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  last_auth_at?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  name?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  public_key?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type: "webauthn-roaming"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  usage: ("primary" | "secondary")[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/modules.html b/docs/modules.html index 8ed27d96..70149708 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1 +1,55 @@ -@auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @auth0/auth0-angular

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Enumerations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HttpMethod
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ResponseType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Classes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AbstractNavigator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Auth0ClientFactory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AuthClientConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AuthenticationError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AuthGuard
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AuthHttpInterceptor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AuthModule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AuthService
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AuthState
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ConnectError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Fetcher
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GenericError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      InMemoryCache
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      LocalStorageCache
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      MfaChallengeError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      MfaEnrollmentError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      MfaEnrollmentFactorsError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      MfaError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      MfaListAuthenticatorsError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      MfaRequiredError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      MfaVerifyError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      MissingRefreshTokenError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      MyAccountApiError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PasskeyChallengeError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PasskeyError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PasskeyGetTokenError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PasskeyRegisterError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PopupCancelledError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PopupOpenError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PopupTimeoutError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      TimeoutError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      UseDpopNonceError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      User

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AppState
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AuthConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Authenticator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AuthorizationParams
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ChallengeAuthenticatorParams
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EmailAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EmailEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EmailEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EmailEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EnrollEmailParams
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EnrollmentFactor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EnrollOtpParams
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EnrollPushParams
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EnrollSmsParams
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EnrollVoiceParams
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Factor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GetTokenSilentlyOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GetTokenWithPopupOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HttpInterceptorConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HttpInterceptorRouteConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ICache
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      IdToken
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      LogoutOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      MyAccountApiClient
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ObservableMfaApiClient
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ObservableMyAccountApiClient
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ObservablePasskeyApiClient
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      OobEnrollmentResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      OtpEnrollmentResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PasskeyApiClient
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PasskeyAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PasskeyCreationOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PasskeyCredentialResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PasskeyEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PasskeyEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PasskeyEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PasskeyErrorResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PasskeyLoginChallengeOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PasskeyLoginChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PasskeyRequestOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PasskeySignupChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PasswordAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PasswordEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PasswordEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PasswordEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PhoneAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PhoneEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PhoneEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PhoneEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PopupConfigOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PopupLoginOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PushNotificationAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PushNotificationEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PushNotificationEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PushNotificationEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      RecoveryCodeAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      RecoveryCodeEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      RecoveryCodeEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      RecoveryCodeEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      RedirectConnectAccountOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      RedirectLoginOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      TotpAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      TotpEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      TotpEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      TotpEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      UpdateAuthenticationMethodRequest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      VerifyParams
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      WebAuthnPlatformAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      WebAuthnRoamingAuthenticationMethod

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Aliases

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ApiRouteDefinition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AuthenticationMethodType
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AuthenticatorType
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Cacheable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ConnectAccountRedirectResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ConnectedAccount
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      CustomFetchMinimalOutput
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      CustomTokenExchangeOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EnrollmentResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EnrollParams
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      FetcherConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      InteractiveErrorHandler
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      MfaFactorType
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      MfaGrantType
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      OobChannel
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PasskeyLoginOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PasskeySignupChallengeOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PasskeySignupOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      TokenEndpointResponse

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Variables

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Auth0ClientService
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AuthConfigService

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      authGuardFn
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      authHttpInterceptorFn
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      isHttpInterceptorRouteConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      provideAuth0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +@auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @auth0/auth0-angular

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          HttpMethod
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ResponseType
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          AbstractNavigator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Auth0ClientFactory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          AuthClientConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          AuthenticationError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          AuthGuard
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          AuthHttpInterceptor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          AuthModule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          AuthService
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          AuthState
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ConnectError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Fetcher
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GenericError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          InMemoryCache
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          InvalidConfigurationError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          LocalStorageCache
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          MfaChallengeError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          MfaEnrollmentError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          MfaEnrollmentFactorsError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          MfaError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          MfaListAuthenticatorsError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          MfaRequiredError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          MfaVerifyError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          MissingRefreshTokenError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          MissingScopesError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          MyAccountApiError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PasskeyChallengeError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PasskeyError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PasskeyGetTokenError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PasskeyRegisterError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PopupCancelledError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PopupOpenError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PopupTimeoutError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          TimeoutError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          UseDpopNonceError
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          User
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          AppState
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          AuthConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Authenticator
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          AuthorizationParams
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ChallengeAuthenticatorParams
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          EmailAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          EmailEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          EmailEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          EmailEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          EnrollEmailParams
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          EnrollmentFactor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          EnrollOtpParams
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          EnrollPushParams
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          EnrollSmsParams
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          EnrollVoiceParams
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Factor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GetTokenSilentlyOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GetTokenWithPopupOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          HttpInterceptorConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          HttpInterceptorRouteConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ICache
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          IdToken
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          LogoutOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          MyAccountApiClient
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ObservableMfaApiClient
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ObservableMyAccountApiClient
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ObservablePasskeyApiClient
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          OobEnrollmentResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          OtpEnrollmentResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PasskeyApiClient
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PasskeyAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PasskeyCreationOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PasskeyCredentialResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PasskeyEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PasskeyEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PasskeyEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PasskeyErrorResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PasskeyLoginChallengeOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PasskeyLoginChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PasskeyRequestOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PasskeySignupChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PasswordAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PasswordEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PasswordEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PasswordEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PhoneAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PhoneEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PhoneEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PhoneEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PopupConfigOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PopupLoginOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PushNotificationAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PushNotificationEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PushNotificationEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PushNotificationEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          RecoveryCodeAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          RecoveryCodeEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          RecoveryCodeEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          RecoveryCodeEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          RedirectConnectAccountOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          RedirectLoginOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          TotpAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          TotpEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          TotpEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          TotpEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          UpdateAuthenticationMethodRequest
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          VerifyParams
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          WebAuthnPlatformAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          WebAuthnRoamingAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ApiRouteDefinition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          AuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          AuthenticationMethodType
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          AuthenticatorType
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Cacheable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ConnectAccountRedirectResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ConnectedAccount
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          CustomFetchMinimalOutput
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          CustomTokenExchangeOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          EnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          EnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          EnrollmentResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          EnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          EnrollParams
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          FetcherConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          InteractiveErrorHandler
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          MfaFactorType
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          MfaGrantType
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          OobChannel
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PasskeyLoginOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PasskeySignupChallengeOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PasskeySignupOptions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          RefreshTokenMode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          TokenEndpointResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Auth0ClientService
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          AuthConfigService
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          RefreshTokenMode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          authGuardFn
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          authHttpInterceptorFn
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          isHttpInterceptorRouteConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          provideAuth0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/ApiRouteDefinition.html b/docs/types/ApiRouteDefinition.html index f3718b05..f4fd0d26 100644 --- a/docs/types/ApiRouteDefinition.html +++ b/docs/types/ApiRouteDefinition.html @@ -1,266 +1,38 @@ - - - - - - ApiRouteDefinition | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias ApiRouteDefinition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            - ApiRouteDefinition: - HttpInterceptorRouteConfig - | - string -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Defines the type for a route config entry. Can either be:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • an object of type HttpInterceptorRouteConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • a string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            - - +ApiRouteDefinition | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias ApiRouteDefinition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ApiRouteDefinition: HttpInterceptorRouteConfig | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Defines the type for a route config entry. Can either be:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • an object of type HttpInterceptorRouteConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • a string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/AuthenticationMethod.html b/docs/types/AuthenticationMethod.html index 209470fe..fe6fa4bc 100644 --- a/docs/types/AuthenticationMethod.html +++ b/docs/types/AuthenticationMethod.html @@ -1 +1,32 @@ -AuthenticationMethod | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias AuthenticationMethod

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +AuthenticationMethod | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias AuthenticationMethod

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/AuthenticationMethodType.html b/docs/types/AuthenticationMethodType.html index 0305b775..ceb3e17f 100644 --- a/docs/types/AuthenticationMethodType.html +++ b/docs/types/AuthenticationMethodType.html @@ -1 +1,32 @@ -AuthenticationMethodType | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias AuthenticationMethodType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    AuthenticationMethodType:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | "passkey"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | "password"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | "phone"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | "totp"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | "email"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | "push-notification"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | "recovery-code"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | "webauthn-platform"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | "webauthn-roaming"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +AuthenticationMethodType | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias AuthenticationMethodType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AuthenticationMethodType:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "passkey"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "password"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "phone"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "totp"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "email"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "push-notification"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "recovery-code"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "webauthn-platform"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "webauthn-roaming"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/AuthenticatorType.html b/docs/types/AuthenticatorType.html index 1c58752f..f90e8a77 100644 --- a/docs/types/AuthenticatorType.html +++ b/docs/types/AuthenticatorType.html @@ -1,3 +1,35 @@ -AuthenticatorType | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias AuthenticatorType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        AuthenticatorType: "otp" | "oob" | "recovery-code"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Supported authenticator types. +AuthenticatorType | @auth0/auth0-angular

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias AuthenticatorType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          AuthenticatorType: "otp" | "oob" | "recovery-code"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Supported authenticator types. Note: Email authenticators use 'oob' type with oobChannel: 'email'

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/Cacheable.html b/docs/types/Cacheable.html index c9f6cbdf..70c03913 100644 --- a/docs/types/Cacheable.html +++ b/docs/types/Cacheable.html @@ -1 +1,32 @@ -Cacheable | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias Cacheable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Cacheable: WrappedCacheEntry | KeyManifestEntry
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +Cacheable | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias Cacheable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Cacheable: WrappedCacheEntry | KeyManifestEntry
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/ConnectAccountRedirectResult.html b/docs/types/ConnectAccountRedirectResult.html index 543d67c5..c5c9df4f 100644 --- a/docs/types/ConnectAccountRedirectResult.html +++ b/docs/types/ConnectAccountRedirectResult.html @@ -1,10 +1,59 @@ -ConnectAccountRedirectResult | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                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-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/ConnectedAccount.html b/docs/types/ConnectedAccount.html index a8cd7643..83dbee35 100644 --- a/docs/types/ConnectedAccount.html +++ b/docs/types/ConnectedAccount.html @@ -1,269 +1,34 @@ - - - - - - ConnectedAccount | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias ConnectedAccount

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    - ConnectedAccount: - Omit<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ConnectAccountRedirectResult,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "appState"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | - "response_type",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    > -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The account that has been connected during the connect flow.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    - - +ConnectedAccount | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias ConnectedAccount

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ConnectedAccount: Omit<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ConnectAccountRedirectResult,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "appState"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "response_type",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      >
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The account that has been connected during the connect flow.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/CustomFetchMinimalOutput.html b/docs/types/CustomFetchMinimalOutput.html index 71f8e2ff..d13a740a 100644 --- a/docs/types/CustomFetchMinimalOutput.html +++ b/docs/types/CustomFetchMinimalOutput.html @@ -1,3 +1,60 @@ -CustomFetchMinimalOutput | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias CustomFetchMinimalOutput

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type CustomFetchMinimalOutput = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            headers: ResponseHeaders;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            status: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        headers +CustomFetchMinimalOutput | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias CustomFetchMinimalOutput

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type CustomFetchMinimalOutput = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              headers: ResponseHeaders;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              status: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          headers: ResponseHeaders
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          status: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          headers: ResponseHeaders
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          status: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/CustomTokenExchangeOptions.html b/docs/types/CustomTokenExchangeOptions.html index 1b39bc56..0c08769a 100644 --- a/docs/types/CustomTokenExchangeOptions.html +++ b/docs/types/CustomTokenExchangeOptions.html @@ -1,55 +1,164 @@ -CustomTokenExchangeOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias CustomTokenExchangeOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Represents the configuration options required for initiating a Custom Token Exchange request +CustomTokenExchangeOptions | @auth0/auth0-angular

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias CustomTokenExchangeOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Represents the configuration options required for initiating a Custom Token Exchange request following RFC 8693 specifications.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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...",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                } +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/EnrollParams.html b/docs/types/EnrollParams.html index 0b1d4ab5..1555ec1d 100644 --- a/docs/types/EnrollParams.html +++ b/docs/types/EnrollParams.html @@ -1,2 +1,34 @@ -EnrollParams | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias EnrollParams

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                EnrollParams:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | EnrollOtpParams
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | EnrollSmsParams
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | EnrollVoiceParams
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | EnrollEmailParams
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | EnrollPushParams

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Union type for all enrollment parameter types

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +EnrollParams | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias EnrollParams

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  EnrollParams:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | EnrollOtpParams
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | EnrollSmsParams
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | EnrollVoiceParams
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | EnrollEmailParams
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | EnrollPushParams
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Union type for all enrollment parameter types

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/EnrollmentChallengeOptions.html b/docs/types/EnrollmentChallengeOptions.html index de81596e..e63e1acd 100644 --- a/docs/types/EnrollmentChallengeOptions.html +++ b/docs/types/EnrollmentChallengeOptions.html @@ -1 +1,32 @@ -EnrollmentChallengeOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias EnrollmentChallengeOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +EnrollmentChallengeOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias EnrollmentChallengeOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/EnrollmentChallengeResponse.html b/docs/types/EnrollmentChallengeResponse.html index 6414598d..729c4bec 100644 --- a/docs/types/EnrollmentChallengeResponse.html +++ b/docs/types/EnrollmentChallengeResponse.html @@ -1 +1,32 @@ -EnrollmentChallengeResponse | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias EnrollmentChallengeResponse

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +EnrollmentChallengeResponse | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias EnrollmentChallengeResponse

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/EnrollmentResponse.html b/docs/types/EnrollmentResponse.html index 70f18589..d7e8f54d 100644 --- a/docs/types/EnrollmentResponse.html +++ b/docs/types/EnrollmentResponse.html @@ -1,2 +1,34 @@ -EnrollmentResponse | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias EnrollmentResponse

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Union type for all enrollment response types

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +EnrollmentResponse | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias EnrollmentResponse

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Union type for all enrollment response types

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/EnrollmentVerifyOptions.html b/docs/types/EnrollmentVerifyOptions.html index 9cd9fe4b..84a5314b 100644 --- a/docs/types/EnrollmentVerifyOptions.html +++ b/docs/types/EnrollmentVerifyOptions.html @@ -1 +1,32 @@ -EnrollmentVerifyOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias EnrollmentVerifyOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +EnrollmentVerifyOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias EnrollmentVerifyOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/FetcherConfig.html b/docs/types/FetcherConfig.html index e498f181..693357ac 100644 --- a/docs/types/FetcherConfig.html +++ b/docs/types/FetcherConfig.html @@ -1,5 +1,76 @@ -FetcherConfig | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias FetcherConfig<TOutput>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    type FetcherConfig<TOutput extends CustomFetchMinimalOutput> = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        baseUrl?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        dpopNonceId?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        fetch?: CustomFetchImpl<TOutput>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        getAccessToken?: AccessTokenFactory;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    baseUrl? +FetcherConfig | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias FetcherConfig<TOutput>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type FetcherConfig<TOutput extends CustomFetchMinimalOutput> = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          baseUrl?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          dpopNonceId?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          fetch?: CustomFetchImpl<TOutput>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          getAccessToken?: AccessTokenFactory;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      baseUrl?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      dpopNonceId?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      fetch?: CustomFetchImpl<TOutput>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getAccessToken?: AccessTokenFactory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      baseUrl?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      dpopNonceId?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      fetch?: CustomFetchImpl<TOutput>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getAccessToken?: AccessTokenFactory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/InteractiveErrorHandler.html b/docs/types/InteractiveErrorHandler.html index db97bba5..bc86e05a 100644 --- a/docs/types/InteractiveErrorHandler.html +++ b/docs/types/InteractiveErrorHandler.html @@ -1,5 +1,37 @@ -InteractiveErrorHandler | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias InteractiveErrorHandler

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        InteractiveErrorHandler: "popup"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Configuration option for automatic interactive error handling.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +InteractiveErrorHandler | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          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
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/MfaFactorType.html b/docs/types/MfaFactorType.html index 86a44657..4fa52ed8 100644 --- a/docs/types/MfaFactorType.html +++ b/docs/types/MfaFactorType.html @@ -1,2 +1,34 @@ -MfaFactorType | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias MfaFactorType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            MfaFactorType: "otp" | "sms" | "email" | "push" | "voice"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Supported MFA factors for enrollment

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +MfaFactorType | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias MfaFactorType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              MfaFactorType: "otp" | "sms" | "email" | "push" | "voice"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Supported MFA factors for enrollment

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/MfaGrantType.html b/docs/types/MfaGrantType.html index e3b03d82..a5759bdf 100644 --- a/docs/types/MfaGrantType.html +++ b/docs/types/MfaGrantType.html @@ -1,2 +1,34 @@ -MfaGrantType | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias MfaGrantType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                MfaGrantType: typeof MfaGrantTypes[keyof typeof MfaGrantTypes]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Grant types for MFA verification (derived from MfaGrantTypes constants)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +MfaGrantType | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias MfaGrantType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  MfaGrantType: typeof MfaGrantTypes[keyof typeof MfaGrantTypes]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Grant types for MFA verification (derived from MfaGrantTypes constants)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/OobChannel.html b/docs/types/OobChannel.html index 0f647c44..eb933545 100644 --- a/docs/types/OobChannel.html +++ b/docs/types/OobChannel.html @@ -1,3 +1,35 @@ -OobChannel | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias OobChannel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    OobChannel: "sms" | "voice" | "auth0" | "email"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Out-of-band delivery channels. +OobChannel | @auth0/auth0-angular

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias OobChannel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      OobChannel: "sms" | "voice" | "auth0" | "email"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Out-of-band delivery channels. Includes 'email' which is also delivered out-of-band.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/PasskeyLoginOptions.html b/docs/types/PasskeyLoginOptions.html index 658a52d3..f2032bee 100644 --- a/docs/types/PasskeyLoginOptions.html +++ b/docs/types/PasskeyLoginOptions.html @@ -1,2 +1,34 @@ -PasskeyLoginOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias PasskeyLoginOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        PasskeyLoginOptions: PasskeyLoginChallengeOptions & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            audience?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            scope?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Options for passkey login (authenticating with an existing passkey).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +PasskeyLoginOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias PasskeyLoginOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PasskeyLoginOptions: PasskeyLoginChallengeOptions & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              audience?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              scope?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Options for passkey login (authenticating with an existing passkey).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/PasskeySignupChallengeOptions.html b/docs/types/PasskeySignupChallengeOptions.html index eeaa44ee..6b18eb3c 100644 --- a/docs/types/PasskeySignupChallengeOptions.html +++ b/docs/types/PasskeySignupChallengeOptions.html @@ -1,311 +1,36 @@ - - - - - - PasskeySignupChallengeOptions | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias PasskeySignupChallengeOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            - PasskeySignupChallengeOptions: - PasskeySignupChallengeBaseOptions - & (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | - { - email: - string; - phoneNumber?: - string; - username?: - string - }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | - { - email?: - string; - phoneNumber: - string; - username?: - string - }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | - { - email?: - string; - phoneNumber?: - string; - username: - string - }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ) -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Options for requesting a passkey signup challenge.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            - At least one user identifier (email, - username, or phoneNumber) must be - provided. Which identifiers are accepted depends on what is - configured on your database connection. -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            - - +PasskeySignupChallengeOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias PasskeySignupChallengeOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              PasskeySignupChallengeOptions: PasskeySignupChallengeBaseOptions & (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | { email: string; phoneNumber?: string; username?: string }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | { email?: string; phoneNumber: string; username?: string }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | { email?: string; phoneNumber?: string; username: string }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              )
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Options for requesting a passkey signup challenge.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              At least one user identifier (email, username, or phoneNumber) must be provided. +Which identifiers are accepted depends on what is configured on your database connection.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/PasskeySignupOptions.html b/docs/types/PasskeySignupOptions.html index 8c7aaf60..a40bf51f 100644 --- a/docs/types/PasskeySignupOptions.html +++ b/docs/types/PasskeySignupOptions.html @@ -1,2 +1,34 @@ -PasskeySignupOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias PasskeySignupOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                PasskeySignupOptions: PasskeySignupChallengeOptions & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    audience?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    scope?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Options for passkey signup (registering a new user with a passkey).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +PasskeySignupOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias PasskeySignupOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  PasskeySignupOptions: PasskeySignupChallengeOptions & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      audience?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      scope?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Options for passkey signup (registering a new user with a passkey).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/RefreshTokenMode.html b/docs/types/RefreshTokenMode.html new file mode 100644 index 00000000..d319db13 --- /dev/null +++ b/docs/types/RefreshTokenMode.html @@ -0,0 +1,39 @@ +RefreshTokenMode | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias RefreshTokenMode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    RefreshTokenMode: typeof RefreshTokenMode[keyof typeof RefreshTokenMode]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The refresh-token variant used when useRefreshTokens: true.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/types/TokenEndpointResponse.html b/docs/types/TokenEndpointResponse.html index b27f33cb..6a0b9179 100644 --- a/docs/types/TokenEndpointResponse.html +++ b/docs/types/TokenEndpointResponse.html @@ -1,7 +1,84 @@ -TokenEndpointResponse | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        expires_in: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        id_token: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        refresh_token?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        scope?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        token_type: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        access_token: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        expires_in: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        id_token: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        refresh_token?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        scope?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        token_type: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/variables/Auth0ClientService.html b/docs/variables/Auth0ClientService.html index f71e4e43..3638b955 100644 --- a/docs/variables/Auth0ClientService.html +++ b/docs/variables/Auth0ClientService.html @@ -1,257 +1,32 @@ - - - - - - Auth0ClientService | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Variable Auth0ClientServiceConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          - Auth0ClientService: - InjectionToken<Auth0Client> = ... -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          - - +Auth0ClientService | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Variable Auth0ClientServiceConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Auth0ClientService: InjectionToken<Auth0Client> = ...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/variables/AuthConfigService.html b/docs/variables/AuthConfigService.html index 5d707d8d..ba99347f 100644 --- a/docs/variables/AuthConfigService.html +++ b/docs/variables/AuthConfigService.html @@ -1,282 +1,41 @@ - - - - - - AuthConfigService | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Variable AuthConfigServiceConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              - AuthConfigService: - InjectionToken<AuthConfig> = ... -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Injection token for accessing configuration.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              - Use the Inject decorator to access the configuration - from a service or component: -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              class MyService(@Inject(AuthConfigService) config: AuthConfig) {}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +AuthConfigService | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Variable AuthConfigServiceConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                AuthConfigService: InjectionToken<AuthConfig> = ...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Injection token for accessing configuration.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Use the Inject decorator to access the configuration from a service or component:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                class MyService(@Inject(AuthConfigService) config: AuthConfig) {}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                - - + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/variables/RefreshTokenMode.html b/docs/variables/RefreshTokenMode.html new file mode 100644 index 00000000..e014aaa4 --- /dev/null +++ b/docs/variables/RefreshTokenMode.html @@ -0,0 +1,46 @@ +RefreshTokenMode | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @auth0/auth0-angular + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Variable RefreshTokenModeConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  RefreshTokenMode: { Offline: "offline"; Online: "online" }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The refresh-token variant used when useRefreshTokens: true.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ReadonlyOffline: "offline"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ReadonlyOnline: "online"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/projects/auth0-angular/package.json b/projects/auth0-angular/package.json index 90bdea3f..28a768ee 100644 --- a/projects/auth0-angular/package.json +++ b/projects/auth0-angular/package.json @@ -1,6 +1,6 @@ { "name": "@auth0/auth0-angular", - "version": "2.10.1", + "version": "2.11.0", "description": "Auth0 SDK for Angular Single Page Applications (SPA)", "keywords": [ "auth0",