@sudoplatform/sudo-user 13.0.2 → 14.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (68) hide show
  1. package/cjs/client/apiClient.js +41 -20
  2. package/cjs/client/apiClient.js.map +1 -1
  3. package/cjs/client/transformer/ErrorTransformer.js +23 -0
  4. package/cjs/client/transformer/ErrorTransformer.js.map +1 -0
  5. package/cjs/core/auth-store.js +1 -1
  6. package/cjs/core/auth-store.js.map +1 -1
  7. package/cjs/core/key-manager.js.map +1 -1
  8. package/cjs/core/sdk-config.js.map +1 -1
  9. package/cjs/gen/graphql-types.js +26 -1
  10. package/cjs/gen/graphql-types.js.map +1 -1
  11. package/cjs/user/auth-provider.js.map +1 -1
  12. package/cjs/user/auth.js.map +1 -1
  13. package/cjs/user/error.js.map +1 -1
  14. package/cjs/user/identity-provider.js.map +1 -1
  15. package/cjs/user/user-client.js +14 -6
  16. package/cjs/user/user-client.js.map +1 -1
  17. package/cjs/utils/parse-token.js.map +1 -1
  18. package/cjs/utils/sign-options-builder.js.map +1 -1
  19. package/docs/assets/icons.js +15 -0
  20. package/docs/assets/icons.svg +1 -0
  21. package/docs/assets/main.js +4 -3
  22. package/docs/assets/navigation.js +1 -0
  23. package/docs/assets/search.js +1 -1
  24. package/docs/assets/style.css +77 -32
  25. package/docs/classes/AlreadyRegisteredError.html +12 -174
  26. package/docs/classes/DefaultSudoUserClient.html +87 -600
  27. package/docs/classes/IdentityServiceConfigNotFoundError.html +12 -174
  28. package/docs/classes/LocalAuthenticationProvider.html +13 -141
  29. package/docs/classes/TESTAuthenticationProvider.html +14 -156
  30. package/docs/functions/internal.getIdentityServiceConfig.html +1 -64
  31. package/docs/hierarchy.html +1 -0
  32. package/docs/index.html +2 -58
  33. package/docs/interfaces/AuthenticationProvider.html +6 -98
  34. package/docs/interfaces/AuthenticationTokens.html +10 -106
  35. package/docs/interfaces/SudoUserClient.html +78 -469
  36. package/docs/modules/internal.html +8 -77
  37. package/docs/modules.html +10 -64
  38. package/docs/types/internal.Config.html +1 -61
  39. package/docs/types/internal.FederatedSignInConfig.html +1 -60
  40. package/docs/types/internal.IdentityServiceConfig.html +1 -60
  41. package/docs/variables/internal.Config-1.html +1 -61
  42. package/docs/variables/internal.FederatedSignInConfigCodec.html +1 -60
  43. package/docs/variables/internal.IdentityServiceConfigCodec.html +1 -60
  44. package/lib/client/apiClient.js +43 -22
  45. package/lib/client/apiClient.js.map +1 -1
  46. package/lib/client/transformer/ErrorTransformer.js +19 -0
  47. package/lib/client/transformer/ErrorTransformer.js.map +1 -0
  48. package/lib/core/auth-store.js +1 -1
  49. package/lib/core/auth-store.js.map +1 -1
  50. package/lib/core/key-manager.js.map +1 -1
  51. package/lib/core/sdk-config.js.map +1 -1
  52. package/lib/gen/graphql-types.js +25 -0
  53. package/lib/gen/graphql-types.js.map +1 -1
  54. package/lib/user/auth-provider.js.map +1 -1
  55. package/lib/user/auth.js.map +1 -1
  56. package/lib/user/error.js.map +1 -1
  57. package/lib/user/identity-provider.js.map +1 -1
  58. package/lib/user/user-client.js +14 -6
  59. package/lib/user/user-client.js.map +1 -1
  60. package/lib/utils/parse-token.js.map +1 -1
  61. package/lib/utils/sign-options-builder.js.map +1 -1
  62. package/package.json +41 -37
  63. package/types/client/apiClient.d.ts +4 -2
  64. package/types/client/transformer/ErrorTransformer.d.ts +2 -0
  65. package/types/core/auth-store.d.ts +1 -1
  66. package/types/gen/graphql-types.d.ts +19 -1
  67. package/types/user/user-client-interface.d.ts +7 -1
  68. package/types/user/user-client.d.ts +2 -1
package/docs/classes/DefaultSudoUserClient.html CHANGED
@@ -1,615 +1,102 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DefaultSudoUserClient | @sudoplatform/sudo-user</title><meta name="description" content="Documentation for @sudoplatform/sudo-user"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
- <div class="tsd-toolbar-contents container">
3
- <div class="table-cell" id="tsd-search" data-base="..">
4
- <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
5
- <div class="field">
6
- <div id="tsd-toolbar-links"></div></div>
7
- <ul class="results">
8
- <li class="state loading">Preparing search index...</li>
9
- <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@sudoplatform/sudo-user</a></div>
10
- <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
11
- <div class="container container-main">
12
- <div class="col-content">
13
- <div class="tsd-page-title">
14
- <ul class="tsd-breadcrumb">
15
- <li><a href="../modules.html">@sudoplatform/sudo-user</a></li>
16
- <li><a href="DefaultSudoUserClient.html">DefaultSudoUserClient</a></li></ul>
17
- <h1>Class DefaultSudoUserClient</h1></div>
18
- <section class="tsd-panel tsd-comment">
19
- <div class="tsd-comment tsd-typography"><p>Interface encapsulating a library of functions for calling Sudo Platform identity service,
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DefaultSudoUserClient | @sudoplatform/sudo-user</title><meta name="description" content="Documentation for @sudoplatform/sudo-user"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@sudoplatform/sudo-user</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@sudoplatform/sudo-user</a></li><li><a href="DefaultSudoUserClient.html">DefaultSudoUserClient</a></li></ul><h1>Class DefaultSudoUserClient</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Interface encapsulating a library of functions for calling Sudo Platform identity service,
20
2
  handling federated sign in, managing keys and performing cryptographic operations.</p>
21
- </div>
22
- <div class="tsd-comment tsd-typography"></div></section>
23
- <section class="tsd-panel tsd-hierarchy">
24
- <h4>Hierarchy</h4>
25
- <ul class="tsd-hierarchy">
26
- <li><span class="target">DefaultSudoUserClient</span></li></ul></section>
27
- <section class="tsd-panel">
28
- <h4>Implements</h4>
29
- <ul class="tsd-hierarchy">
30
- <li><a href="../interfaces/SudoUserClient.html" class="tsd-signature-type tsd-kind-interface">SudoUserClient</a></li></ul></section><aside class="tsd-sources">
31
- <ul>
32
- <li>Defined in src/user/user-client.ts:51</li></ul></aside>
33
- <section class="tsd-panel-group tsd-index-group">
34
- <section class="tsd-panel tsd-index-panel">
35
- <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
36
- <h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex=0><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></svg> Index</h5></summary>
37
- <div class="tsd-accordion-details">
38
- <section class="tsd-index-section">
39
- <h3 class="tsd-index-heading">Constructors</h3>
40
- <div class="tsd-index-list"><a href="DefaultSudoUserClient.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-512"><rect fill="var(--color-icon-background)" stroke="#4D7FFF" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>constructor</span></a>
41
- </div></section>
42
- <section class="tsd-index-section">
43
- <h3 class="tsd-index-heading">Accessors</h3>
44
- <div class="tsd-index-list"><a href="DefaultSudoUserClient.html#sudoKeyManager" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-262144"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)"></path></g></svg><span>sudo<wbr/>Key<wbr/>Manager</span></a>
45
- </div></section>
46
- <section class="tsd-index-section">
47
- <h3 class="tsd-index-heading">Methods</h3>
48
- <div class="tsd-index-list"><a href="DefaultSudoUserClient.html#clearAuthenticationTokens" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-2048"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)"></path></g></svg><span>clear<wbr/>Authentication<wbr/>Tokens</span></a>
49
- <a href="DefaultSudoUserClient.html#deregister" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>deregister</span></a>
50
- <a href="DefaultSudoUserClient.html#getAccessToken" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Access<wbr/>Token</span></a>
51
- <a href="DefaultSudoUserClient.html#getIdToken" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Id<wbr/>Token</span></a>
52
- <a href="DefaultSudoUserClient.html#getLatestAuthToken" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Latest<wbr/>Auth<wbr/>Token</span></a>
53
- <a href="DefaultSudoUserClient.html#getRefreshToken" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Refresh<wbr/>Token</span></a>
54
- <a href="DefaultSudoUserClient.html#getRefreshTokenExpiry" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Refresh<wbr/>Token<wbr/>Expiry</span></a>
55
- <a href="DefaultSudoUserClient.html#getSubject" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Subject</span></a>
56
- <a href="DefaultSudoUserClient.html#getTokenExpiry" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Token<wbr/>Expiry</span></a>
57
- <a href="DefaultSudoUserClient.html#getUserClaim" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>User<wbr/>Claim</span></a>
58
- <a href="DefaultSudoUserClient.html#getUserName" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>User<wbr/>Name</span></a>
59
- <a href="DefaultSudoUserClient.html#globalSignOut" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>global<wbr/>Sign<wbr/>Out</span></a>
60
- <a href="DefaultSudoUserClient.html#isRegistered" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Registered</span></a>
61
- <a href="DefaultSudoUserClient.html#isSignedIn" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Signed<wbr/>In</span></a>
62
- <a href="DefaultSudoUserClient.html#presentFederatedSignInUI" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>present<wbr/>Federated<wbr/>Sign<wbr/>InUI</span></a>
63
- <a href="DefaultSudoUserClient.html#presentSignOutUI" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>present<wbr/>Sign<wbr/>OutUI</span></a>
64
- <a href="DefaultSudoUserClient.html#processFederatedSignInTokens" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>process<wbr/>Federated<wbr/>Sign<wbr/>In<wbr/>Tokens</span></a>
65
- <a href="DefaultSudoUserClient.html#refreshTokens" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>refresh<wbr/>Tokens</span></a>
66
- <a href="DefaultSudoUserClient.html#registerWithAuthenticationProvider" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>register<wbr/>With<wbr/>Authentication<wbr/>Provider</span></a>
67
- <a href="DefaultSudoUserClient.html#reset" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>reset</span></a>
68
- <a href="DefaultSudoUserClient.html#setAuthUI" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>AuthUI</span></a>
69
- <a href="DefaultSudoUserClient.html#setAuthenticationStore" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Authentication<wbr/>Store</span></a>
70
- <a href="DefaultSudoUserClient.html#setIdentityProvider" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Identity<wbr/>Provider</span></a>
71
- <a href="DefaultSudoUserClient.html#setLaunchUriFn" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Launch<wbr/>Uri<wbr/>Fn</span></a>
72
- <a href="DefaultSudoUserClient.html#setUserName" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>User<wbr/>Name</span></a>
73
- <a href="DefaultSudoUserClient.html#signInWithAuthenticationProvider" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>sign<wbr/>In<wbr/>With<wbr/>Authentication<wbr/>Provider</span></a>
74
- <a href="DefaultSudoUserClient.html#signInWithKey" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>sign<wbr/>In<wbr/>With<wbr/>Key</span></a>
75
- <a href="DefaultSudoUserClient.html#signOut" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>sign<wbr/>Out</span></a>
76
- </div></section></div></details></section></section>
77
- <section class="tsd-panel-group tsd-member-group">
78
- <h2>Constructors</h2>
79
- <section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a>
80
- <h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3>
81
- <ul class="tsd-signatures">
82
- <li class="tsd-signature tsd-anchor-link" id="constructor.new_DefaultSudoUserClient"><span class="tsd-kind-constructor-signature">new <wbr/>Default<wbr/>Sudo<wbr/>User<wbr/>Client</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="DefaultSudoUserClient.html" class="tsd-signature-type tsd-kind-class">DefaultSudoUserClient</a><a href="#constructor.new_DefaultSudoUserClient" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
83
- <li class="tsd-description">
84
- <div class="tsd-parameters">
85
- <h4 class="tsd-parameters-title">Parameters</h4>
86
- <ul class="tsd-parameter-list">
87
- <li>
88
- <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">SudoUserOptions</span></h5></li></ul></div>
89
- <h4 class="tsd-returns-title">Returns <a href="DefaultSudoUserClient.html" class="tsd-signature-type tsd-kind-class">DefaultSudoUserClient</a></h4><aside class="tsd-sources">
90
- <ul>
91
- <li>Defined in src/user/user-client.ts:62</li></ul></aside></li></ul></section></section>
92
- <section class="tsd-panel-group tsd-member-group">
93
- <h2>Accessors</h2>
94
- <section class="tsd-panel tsd-member"><a id="sudoKeyManager" class="tsd-anchor"></a>
95
- <h3 class="tsd-anchor-link"><span>sudo<wbr/>Key<wbr/>Manager</span><a href="#sudoKeyManager" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
96
- <ul class="tsd-signatures">
97
- <li class="tsd-signature" id="sudoKeyManager.sudoKeyManager-1"><span class="tsd-signature-symbol">get</span> sudoKeyManager<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">SudoKeyManager</span></li>
98
- <li class="tsd-description">
99
- <div class="tsd-comment tsd-typography"><p>Getter to retrieve the SudoKeyManager</p>
100
- </div>
101
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">SudoKeyManager</span></h4>
102
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
103
- <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#sudoKeyManager">sudoKeyManager</a></p>
104
- <ul>
105
- <li>Defined in src/user/user-client.ts:114</li></ul></aside></li></ul></section></section>
106
- <section class="tsd-panel-group tsd-member-group">
107
- <h2>Methods</h2>
108
- <section class="tsd-panel tsd-member"><a id="clearAuthenticationTokens" class="tsd-anchor"></a>
109
- <h3 class="tsd-anchor-link"><span>clear<wbr/>Authentication<wbr/>Tokens</span><a href="#clearAuthenticationTokens" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
110
- <ul class="tsd-signatures">
111
- <li class="tsd-signature tsd-anchor-link" id="clearAuthenticationTokens.clearAuthenticationTokens-1"><span class="tsd-kind-call-signature">clear<wbr/>Authentication<wbr/>Tokens</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#clearAuthenticationTokens.clearAuthenticationTokens-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
112
- <li class="tsd-description">
113
- <div class="tsd-comment tsd-typography"><p>Clears cached authentication tokens.</p>
114
- </div>
115
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
116
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
117
- <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#clearAuthenticationTokens">clearAuthenticationTokens</a></p>
118
- <ul>
119
- <li>Defined in src/user/user-client.ts:418</li></ul></aside></li></ul></section>
120
- <section class="tsd-panel tsd-member"><a id="deregister" class="tsd-anchor"></a>
121
- <h3 class="tsd-anchor-link"><span>deregister</span><a href="#deregister" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
122
- <ul class="tsd-signatures">
123
- <li class="tsd-signature tsd-anchor-link" id="deregister.deregister-1"><span class="tsd-kind-call-signature">deregister</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#deregister.deregister-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
124
- <li class="tsd-description">
125
- <div class="tsd-comment tsd-typography"><p>De-registers the user associated with this client. The user must
3
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/SudoUserClient.html" class="tsd-signature-type tsd-kind-interface">SudoUserClient</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in src/user/user-client.ts:51</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="DefaultSudoUserClient.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
4
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="DefaultSudoUserClient.html#sudoKeyManager" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>sudo<wbr/>Key<wbr/>Manager</span></a>
5
+ </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="DefaultSudoUserClient.html#clearAuthenticationTokens" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clear<wbr/>Authentication<wbr/>Tokens</span></a>
6
+ <a href="DefaultSudoUserClient.html#deregister" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>deregister</span></a>
7
+ <a href="DefaultSudoUserClient.html#getAccessToken" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Access<wbr/>Token</span></a>
8
+ <a href="DefaultSudoUserClient.html#getIdToken" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Id<wbr/>Token</span></a>
9
+ <a href="DefaultSudoUserClient.html#getLatestAuthToken" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Latest<wbr/>Auth<wbr/>Token</span></a>
10
+ <a href="DefaultSudoUserClient.html#getRefreshToken" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Refresh<wbr/>Token</span></a>
11
+ <a href="DefaultSudoUserClient.html#getRefreshTokenExpiry" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Refresh<wbr/>Token<wbr/>Expiry</span></a>
12
+ <a href="DefaultSudoUserClient.html#getSubject" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Subject</span></a>
13
+ <a href="DefaultSudoUserClient.html#getTokenExpiry" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Token<wbr/>Expiry</span></a>
14
+ <a href="DefaultSudoUserClient.html#getUserClaim" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>User<wbr/>Claim</span></a>
15
+ <a href="DefaultSudoUserClient.html#getUserName" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>User<wbr/>Name</span></a>
16
+ <a href="DefaultSudoUserClient.html#globalSignOut" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>global<wbr/>Sign<wbr/>Out</span></a>
17
+ <a href="DefaultSudoUserClient.html#isRegistered" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Registered</span></a>
18
+ <a href="DefaultSudoUserClient.html#isSignedIn" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Signed<wbr/>In</span></a>
19
+ <a href="DefaultSudoUserClient.html#presentFederatedSignInUI" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>present<wbr/>Federated<wbr/>Sign<wbr/>InUI</span></a>
20
+ <a href="DefaultSudoUserClient.html#presentSignOutUI" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>present<wbr/>Sign<wbr/>OutUI</span></a>
21
+ <a href="DefaultSudoUserClient.html#processFederatedSignInTokens" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>process<wbr/>Federated<wbr/>Sign<wbr/>In<wbr/>Tokens</span></a>
22
+ <a href="DefaultSudoUserClient.html#refreshTokens" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>refresh<wbr/>Tokens</span></a>
23
+ <a href="DefaultSudoUserClient.html#registerWithAuthenticationProvider" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>register<wbr/>With<wbr/>Authentication<wbr/>Provider</span></a>
24
+ <a href="DefaultSudoUserClient.html#reset" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reset</span></a>
25
+ <a href="DefaultSudoUserClient.html#resetUserData" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reset<wbr/>User<wbr/>Data</span></a>
26
+ <a href="DefaultSudoUserClient.html#setAuthUI" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>AuthUI</span></a>
27
+ <a href="DefaultSudoUserClient.html#setAuthenticationStore" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Authentication<wbr/>Store</span></a>
28
+ <a href="DefaultSudoUserClient.html#setIdentityProvider" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Identity<wbr/>Provider</span></a>
29
+ <a href="DefaultSudoUserClient.html#setLaunchUriFn" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Launch<wbr/>Uri<wbr/>Fn</span></a>
30
+ <a href="DefaultSudoUserClient.html#setUserName" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>User<wbr/>Name</span></a>
31
+ <a href="DefaultSudoUserClient.html#signInWithAuthenticationProvider" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sign<wbr/>In<wbr/>With<wbr/>Authentication<wbr/>Provider</span></a>
32
+ <a href="DefaultSudoUserClient.html#signInWithKey" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sign<wbr/>In<wbr/>With<wbr/>Key</span></a>
33
+ <a href="DefaultSudoUserClient.html#signOut" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sign<wbr/>Out</span></a>
34
+ </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_DefaultSudoUserClient" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Default<wbr/>Sudo<wbr/>User<wbr/>Client</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="DefaultSudoUserClient.html" class="tsd-signature-type tsd-kind-class">DefaultSudoUserClient</a><a href="#constructor.new_DefaultSudoUserClient" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">SudoUserOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="DefaultSudoUserClient.html" class="tsd-signature-type tsd-kind-class">DefaultSudoUserClient</a></h4><aside class="tsd-sources"><ul><li>Defined in src/user/user-client.ts:62</li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Accessors</h2><section class="tsd-panel tsd-member"><a id="sudoKeyManager" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>sudo<wbr/>Key<wbr/>Manager</span><a href="#sudoKeyManager" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="sudoKeyManager.sudoKeyManager-1"><span class="tsd-signature-keyword">get</span> sudoKeyManager<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SudoKeyManager</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Getter to retrieve the SudoKeyManager</p>
35
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SudoKeyManager</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#sudoKeyManager">sudoKeyManager</a></p><ul><li>Defined in src/user/user-client.ts:114</li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="clearAuthenticationTokens" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>clear<wbr/>Authentication<wbr/>Tokens</span><a href="#clearAuthenticationTokens" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="clearAuthenticationTokens.clearAuthenticationTokens-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">clear<wbr/>Authentication<wbr/>Tokens</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#clearAuthenticationTokens.clearAuthenticationTokens-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Clears cached authentication tokens.</p>
36
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#clearAuthenticationTokens">clearAuthenticationTokens</a></p><ul><li>Defined in src/user/user-client.ts:417</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="deregister" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>deregister</span><a href="#deregister" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="deregister.deregister-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">deregister</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#deregister.deregister-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>De-registers the user associated with this client. The user must
126
37
  be signed in.</p>
127
- </div>
128
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
129
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
130
- <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#deregister">deregister</a></p>
131
- <ul>
132
- <li>Defined in src/user/user-client.ts:412</li></ul></aside></li></ul></section>
133
- <section class="tsd-panel tsd-member"><a id="getAccessToken" class="tsd-anchor"></a>
134
- <h3 class="tsd-anchor-link"><span>get<wbr/>Access<wbr/>Token</span><a href="#getAccessToken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
135
- <ul class="tsd-signatures">
136
- <li class="tsd-signature tsd-anchor-link" id="getAccessToken.getAccessToken-1"><span class="tsd-kind-call-signature">get<wbr/>Access<wbr/>Token</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#getAccessToken.getAccessToken-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
137
- <li class="tsd-description">
138
- <div class="tsd-comment tsd-typography"><p>Returns the access token cached from the last sign-in.</p>
139
- </div>
140
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>access token.</p>
141
-
142
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
143
- <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getAccessToken">getAccessToken</a></p>
144
- <ul>
145
- <li>Defined in src/user/user-client.ts:152</li></ul></aside></li></ul></section>
146
- <section class="tsd-panel tsd-member"><a id="getIdToken" class="tsd-anchor"></a>
147
- <h3 class="tsd-anchor-link"><span>get<wbr/>Id<wbr/>Token</span><a href="#getIdToken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
148
- <ul class="tsd-signatures">
149
- <li class="tsd-signature tsd-anchor-link" id="getIdToken.getIdToken-1"><span class="tsd-kind-call-signature">get<wbr/>Id<wbr/>Token</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#getIdToken.getIdToken-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
150
- <li class="tsd-description">
151
- <div class="tsd-comment tsd-typography"><p>Returns the ID token cached from the last sign-in.</p>
152
- </div>
153
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>ID token.</p>
154
-
155
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
156
- <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getIdToken">getIdToken</a></p>
157
- <ul>
158
- <li>Defined in src/user/user-client.ts:148</li></ul></aside></li></ul></section>
159
- <section class="tsd-panel tsd-member"><a id="getLatestAuthToken" class="tsd-anchor"></a>
160
- <h3 class="tsd-anchor-link"><span>get<wbr/>Latest<wbr/>Auth<wbr/>Token</span><a href="#getLatestAuthToken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
161
- <ul class="tsd-signatures">
162
- <li class="tsd-signature tsd-anchor-link" id="getLatestAuthToken.getLatestAuthToken-1"><span class="tsd-kind-call-signature">get<wbr/>Latest<wbr/>Auth<wbr/>Token</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#getLatestAuthToken.getLatestAuthToken-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
163
- <li class="tsd-description">
164
- <div class="tsd-comment tsd-typography"><p>Retrieves the latest ID token. This is to be used by the AWS AppSync client.</p>
165
- </div>
166
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the latest ID token</p>
167
-
168
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
169
- <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getLatestAuthToken">getLatestAuthToken</a></p>
170
- <ul>
171
- <li>Defined in src/user/user-client.ts:243</li></ul></aside></li></ul></section>
172
- <section class="tsd-panel tsd-member"><a id="getRefreshToken" class="tsd-anchor"></a>
173
- <h3 class="tsd-anchor-link"><span>get<wbr/>Refresh<wbr/>Token</span><a href="#getRefreshToken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
174
- <ul class="tsd-signatures">
175
- <li class="tsd-signature tsd-anchor-link" id="getRefreshToken.getRefreshToken-1"><span class="tsd-kind-call-signature">get<wbr/>Refresh<wbr/>Token</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#getRefreshToken.getRefreshToken-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
176
- <li class="tsd-description">
177
- <div class="tsd-comment tsd-typography"><p>Returns the refresh token cached from the last sign-in.</p>
178
- </div>
179
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>refresh token.</p>
180
-
181
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
182
- <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getRefreshToken">getRefreshToken</a></p>
183
- <ul>
184
- <li>Defined in src/user/user-client.ts:156</li></ul></aside></li></ul></section>
185
- <section class="tsd-panel tsd-member"><a id="getRefreshTokenExpiry" class="tsd-anchor"></a>
186
- <h3 class="tsd-anchor-link"><span>get<wbr/>Refresh<wbr/>Token<wbr/>Expiry</span><a href="#getRefreshTokenExpiry" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
187
- <ul class="tsd-signatures">
188
- <li class="tsd-signature tsd-anchor-link" id="getRefreshTokenExpiry.getRefreshTokenExpiry-1"><span class="tsd-kind-call-signature">get<wbr/>Refresh<wbr/>Token<wbr/>Expiry</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Date</span><span class="tsd-signature-symbol">&gt;</span><a href="#getRefreshTokenExpiry.getRefreshTokenExpiry-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
189
- <li class="tsd-description">
190
- <div class="tsd-comment tsd-typography"><p>Returns the refresh token expiry cached from the last sign-in.</p>
191
- </div>
192
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Date</span><span class="tsd-signature-symbol">&gt;</span></h4><p>refresh token expiry.</p>
193
-
194
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
195
- <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getRefreshTokenExpiry">getRefreshTokenExpiry</a></p>
196
- <ul>
197
- <li>Defined in src/user/user-client.ts:165</li></ul></aside></li></ul></section>
198
- <section class="tsd-panel tsd-member"><a id="getSubject" class="tsd-anchor"></a>
199
- <h3 class="tsd-anchor-link"><span>get<wbr/>Subject</span><a href="#getSubject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
200
- <ul class="tsd-signatures">
201
- <li class="tsd-signature tsd-anchor-link" id="getSubject.getSubject-1"><span class="tsd-kind-call-signature">get<wbr/>Subject</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#getSubject.getSubject-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
202
- <li class="tsd-description">
203
- <div class="tsd-comment tsd-typography"><p>Returns the subject of the user associated with this client.
38
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#deregister">deregister</a></p><ul><li>Defined in src/user/user-client.ts:411</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getAccessToken" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Access<wbr/>Token</span><a href="#getAccessToken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getAccessToken.getAccessToken-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Access<wbr/>Token</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#getAccessToken.getAccessToken-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the access token cached from the last sign-in.</p>
39
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>access token.</p>
40
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getAccessToken">getAccessToken</a></p><ul><li>Defined in src/user/user-client.ts:152</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getIdToken" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Id<wbr/>Token</span><a href="#getIdToken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getIdToken.getIdToken-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Id<wbr/>Token</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#getIdToken.getIdToken-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the ID token cached from the last sign-in.</p>
41
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>ID token.</p>
42
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getIdToken">getIdToken</a></p><ul><li>Defined in src/user/user-client.ts:148</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getLatestAuthToken" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Latest<wbr/>Auth<wbr/>Token</span><a href="#getLatestAuthToken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getLatestAuthToken.getLatestAuthToken-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Latest<wbr/>Auth<wbr/>Token</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#getLatestAuthToken.getLatestAuthToken-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves the latest ID token. This is to be used by the AWS AppSync client.</p>
43
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the latest ID token</p>
44
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getLatestAuthToken">getLatestAuthToken</a></p><ul><li>Defined in src/user/user-client.ts:242</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getRefreshToken" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Refresh<wbr/>Token</span><a href="#getRefreshToken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getRefreshToken.getRefreshToken-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Refresh<wbr/>Token</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#getRefreshToken.getRefreshToken-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the refresh token cached from the last sign-in.</p>
45
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>refresh token.</p>
46
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getRefreshToken">getRefreshToken</a></p><ul><li>Defined in src/user/user-client.ts:156</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getRefreshTokenExpiry" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Refresh<wbr/>Token<wbr/>Expiry</span><a href="#getRefreshTokenExpiry" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getRefreshTokenExpiry.getRefreshTokenExpiry-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Refresh<wbr/>Token<wbr/>Expiry</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">&gt;</span><a href="#getRefreshTokenExpiry.getRefreshTokenExpiry-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the refresh token expiry cached from the last sign-in.</p>
47
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">&gt;</span></h4><p>refresh token expiry.</p>
48
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getRefreshTokenExpiry">getRefreshTokenExpiry</a></p><ul><li>Defined in src/user/user-client.ts:165</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getSubject" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Subject</span><a href="#getSubject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getSubject.getSubject-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Subject</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#getSubject.getSubject-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the subject of the user associated with this client.
204
49
  Note: This is an internal method used by other Sudo platform SDKs.</p>
205
- </div>
206
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>user subject.</p>
207
-
208
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
209
- <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getSubject">getSubject</a></p>
210
- <ul>
211
- <li>Defined in src/user/user-client.ts:195</li></ul></aside></li></ul></section>
212
- <section class="tsd-panel tsd-member"><a id="getTokenExpiry" class="tsd-anchor"></a>
213
- <h3 class="tsd-anchor-link"><span>get<wbr/>Token<wbr/>Expiry</span><a href="#getTokenExpiry" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
214
- <ul class="tsd-signatures">
215
- <li class="tsd-signature tsd-anchor-link" id="getTokenExpiry.getTokenExpiry-1"><span class="tsd-kind-call-signature">get<wbr/>Token<wbr/>Expiry</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Date</span><span class="tsd-signature-symbol">&gt;</span><a href="#getTokenExpiry.getTokenExpiry-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
216
- <li class="tsd-description">
217
- <div class="tsd-comment tsd-typography"><p>Returns the ID and access token expiry cached from the last sign-in.</p>
218
- </div>
219
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Date</span><span class="tsd-signature-symbol">&gt;</span></h4><p>token expiry.</p>
220
-
221
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
222
- <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getTokenExpiry">getTokenExpiry</a></p>
223
- <ul>
224
- <li>Defined in src/user/user-client.ts:160</li></ul></aside></li></ul></section>
225
- <section class="tsd-panel tsd-member"><a id="getUserClaim" class="tsd-anchor"></a>
226
- <h3 class="tsd-anchor-link"><span>get<wbr/>User<wbr/>Claim</span><a href="#getUserClaim" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
227
- <ul class="tsd-signatures">
228
- <li class="tsd-signature tsd-anchor-link" id="getUserClaim.getUserClaim-1"><span class="tsd-kind-call-signature">get<wbr/>User<wbr/>Claim</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><a href="#getUserClaim.getUserClaim-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
229
- <li class="tsd-description">
230
- <div class="tsd-comment tsd-typography"><p>Returns the specified claim associated with the user&#39;s identity.</p>
231
- </div>
232
- <div class="tsd-parameters">
233
- <h4 class="tsd-parameters-title">Parameters</h4>
234
- <ul class="tsd-parameter-list">
235
- <li>
236
- <h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
237
- <div class="tsd-comment tsd-typography"><p>claim name.</p>
238
- </div>
239
- <div class="tsd-comment tsd-typography"></div></li></ul></div>
240
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
241
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
242
- <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getUserClaim">getUserClaim</a></p>
243
- <ul>
244
- <li>Defined in src/user/user-client.ts:189</li></ul></aside></li></ul></section>
245
- <section class="tsd-panel tsd-member"><a id="getUserName" class="tsd-anchor"></a>
246
- <h3 class="tsd-anchor-link"><span>get<wbr/>User<wbr/>Name</span><a href="#getUserName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
247
- <ul class="tsd-signatures">
248
- <li class="tsd-signature tsd-anchor-link" id="getUserName.getUserName-1"><span class="tsd-kind-call-signature">get<wbr/>User<wbr/>Name</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#getUserName.getUserName-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
249
- <li class="tsd-description">
250
- <div class="tsd-comment tsd-typography"><p>Returns the user name associated with this client. The username maybe needed to contact
50
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>user subject.</p>
51
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getSubject">getSubject</a></p><ul><li>Defined in src/user/user-client.ts:195</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getTokenExpiry" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Token<wbr/>Expiry</span><a href="#getTokenExpiry" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getTokenExpiry.getTokenExpiry-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Token<wbr/>Expiry</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">&gt;</span><a href="#getTokenExpiry.getTokenExpiry-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the ID and access token expiry cached from the last sign-in.</p>
52
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">&gt;</span></h4><p>token expiry.</p>
53
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getTokenExpiry">getTokenExpiry</a></p><ul><li>Defined in src/user/user-client.ts:160</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getUserClaim" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>User<wbr/>Claim</span><a href="#getUserClaim" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getUserClaim.getUserClaim-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>User<wbr/>Claim</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><a href="#getUserClaim.getUserClaim-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the specified claim associated with the user&#39;s identity.</p>
54
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>claim name.</p>
55
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getUserClaim">getUserClaim</a></p><ul><li>Defined in src/user/user-client.ts:189</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getUserName" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>User<wbr/>Name</span><a href="#getUserName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getUserName.getUserName-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>User<wbr/>Name</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#getUserName.getUserName-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the user name associated with this client. The username maybe needed to contact
251
56
  the support team when diagnosing an issue related to a specific user.</p>
252
- </div>
253
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>user name.</p>
254
-
255
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
256
- <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getUserName">getUserName</a></p>
257
- <ul>
258
- <li>Defined in src/user/user-client.ts:176</li></ul></aside></li></ul></section>
259
- <section class="tsd-panel tsd-member"><a id="globalSignOut" class="tsd-anchor"></a>
260
- <h3 class="tsd-anchor-link"><span>global<wbr/>Sign<wbr/>Out</span><a href="#globalSignOut" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
261
- <ul class="tsd-signatures">
262
- <li class="tsd-signature tsd-anchor-link" id="globalSignOut.globalSignOut-1"><span class="tsd-kind-call-signature">global<wbr/>Sign<wbr/>Out</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#globalSignOut.globalSignOut-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
263
- <li class="tsd-description">
264
- <div class="tsd-comment tsd-typography"><p>Signs out the user from all devices.</p>
265
- </div>
266
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
267
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
268
- <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#globalSignOut">globalSignOut</a></p>
269
- <ul>
270
- <li>Defined in src/user/user-client.ts:295</li></ul></aside></li></ul></section>
271
- <section class="tsd-panel tsd-member"><a id="isRegistered" class="tsd-anchor"></a>
272
- <h3 class="tsd-anchor-link"><span>is<wbr/>Registered</span><a href="#isRegistered" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
273
- <ul class="tsd-signatures">
274
- <li class="tsd-signature tsd-anchor-link" id="isRegistered.isRegistered-1"><span class="tsd-kind-call-signature">is<wbr/>Registered</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><a href="#isRegistered.isRegistered-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
275
- <li class="tsd-description">
276
- <div class="tsd-comment tsd-typography"><p>Indicates whether or not this client is registered with Sudo Platform backend.</p>
277
- </div>
278
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4><p><em>true</em> if the client is registered.</p>
279
-
280
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
281
- <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#isRegistered">isRegistered</a></p>
282
- <ul>
283
- <li>Defined in src/user/user-client.ts:384</li></ul></aside></li></ul></section>
284
- <section class="tsd-panel tsd-member"><a id="isSignedIn" class="tsd-anchor"></a>
285
- <h3 class="tsd-anchor-link"><span>is<wbr/>Signed<wbr/>In</span><a href="#isSignedIn" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
286
- <ul class="tsd-signatures">
287
- <li class="tsd-signature tsd-anchor-link" id="isSignedIn.isSignedIn-1"><span class="tsd-kind-call-signature">is<wbr/>Signed<wbr/>In</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><a href="#isSignedIn.isSignedIn-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
288
- <li class="tsd-description">
289
- <div class="tsd-comment tsd-typography"><p>Indicates whether or not this client is signed in with Sudo Platform backend. The client is
57
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>user name.</p>
58
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getUserName">getUserName</a></p><ul><li>Defined in src/user/user-client.ts:176</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="globalSignOut" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>global<wbr/>Sign<wbr/>Out</span><a href="#globalSignOut" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="globalSignOut.globalSignOut-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">global<wbr/>Sign<wbr/>Out</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#globalSignOut.globalSignOut-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Signs out the user from all devices.</p>
59
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#globalSignOut">globalSignOut</a></p><ul><li>Defined in src/user/user-client.ts:294</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="isRegistered" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Registered</span><a href="#isRegistered" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isRegistered.isRegistered-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Registered</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><a href="#isRegistered.isRegistered-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Indicates whether or not this client is registered with Sudo Platform backend.</p>
60
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4><p><em>true</em> if the client is registered.</p>
61
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#isRegistered">isRegistered</a></p><ul><li>Defined in src/user/user-client.ts:383</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="isSignedIn" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Signed<wbr/>In</span><a href="#isSignedIn" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isSignedIn.isSignedIn-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Signed<wbr/>In</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><a href="#isSignedIn.isSignedIn-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Indicates whether or not this client is signed in with Sudo Platform backend. The client is
290
62
  considered signed in if it cached valid ID, access and refresh tokens.</p>
291
- </div>
292
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4><p><em>true</em> if the client is signed in.</p>
293
-
294
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
295
- <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#isSignedIn">isSignedIn</a></p>
296
- <ul>
297
- <li>Defined in src/user/user-client.ts:199</li></ul></aside></li></ul></section>
298
- <section class="tsd-panel tsd-member"><a id="presentFederatedSignInUI" class="tsd-anchor"></a>
299
- <h3 class="tsd-anchor-link"><span>present<wbr/>Federated<wbr/>Sign<wbr/>InUI</span><a href="#presentFederatedSignInUI" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
300
- <ul class="tsd-signatures">
301
- <li class="tsd-signature tsd-anchor-link" id="presentFederatedSignInUI.presentFederatedSignInUI-1"><span class="tsd-kind-call-signature">present<wbr/>Federated<wbr/>Sign<wbr/>InUI</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#presentFederatedSignInUI.presentFederatedSignInUI-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
302
- <li class="tsd-description">
303
- <div class="tsd-comment tsd-typography"><p>Presents the sign in UI for federated sign in using an external identity provider.</p>
304
- </div>
305
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
306
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
307
- <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#presentFederatedSignInUI">presentFederatedSignInUI</a></p>
308
- <ul>
309
- <li>Defined in src/user/user-client.ts:118</li></ul></aside></li></ul></section>
310
- <section class="tsd-panel tsd-member"><a id="presentSignOutUI" class="tsd-anchor"></a>
311
- <h3 class="tsd-anchor-link"><span>present<wbr/>Sign<wbr/>OutUI</span><a href="#presentSignOutUI" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
312
- <ul class="tsd-signatures">
313
- <li class="tsd-signature tsd-anchor-link" id="presentSignOutUI.presentSignOutUI-1"><span class="tsd-kind-call-signature">present<wbr/>Sign<wbr/>OutUI</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#presentSignOutUI.presentSignOutUI-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
314
- <li class="tsd-description">
315
- <div class="tsd-comment tsd-typography"><p>Presents the Cognito hosted UI signout endpoint.
63
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4><p><em>true</em> if the client is signed in.</p>
64
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#isSignedIn">isSignedIn</a></p><ul><li>Defined in src/user/user-client.ts:199</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="presentFederatedSignInUI" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>present<wbr/>Federated<wbr/>Sign<wbr/>InUI</span><a href="#presentFederatedSignInUI" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="presentFederatedSignInUI.presentFederatedSignInUI-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">present<wbr/>Federated<wbr/>Sign<wbr/>InUI</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#presentFederatedSignInUI.presentFederatedSignInUI-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Presents the sign in UI for federated sign in using an external identity provider.</p>
65
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#presentFederatedSignInUI">presentFederatedSignInUI</a></p><ul><li>Defined in src/user/user-client.ts:118</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="presentSignOutUI" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>present<wbr/>Sign<wbr/>OutUI</span><a href="#presentSignOutUI" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="presentSignOutUI.presentSignOutUI-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">present<wbr/>Sign<wbr/>OutUI</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#presentSignOutUI.presentSignOutUI-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Presents the Cognito hosted UI signout endpoint.
316
66
  When the endpoint is invoked, the hosted web app&#39;s cookies
317
67
  will be invalidated, but the user is not logged out of Cognito.</p>
318
- </div>
319
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
320
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
321
- <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#presentSignOutUI">presentSignOutUI</a></p>
322
- <ul>
323
- <li>Defined in src/user/user-client.ts:431</li></ul></aside></li></ul></section>
324
- <section class="tsd-panel tsd-member"><a id="processFederatedSignInTokens" class="tsd-anchor"></a>
325
- <h3 class="tsd-anchor-link"><span>process<wbr/>Federated<wbr/>Sign<wbr/>In<wbr/>Tokens</span><a href="#processFederatedSignInTokens" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
326
- <ul class="tsd-signatures">
327
- <li class="tsd-signature tsd-anchor-link" id="processFederatedSignInTokens.processFederatedSignInTokens-1"><span class="tsd-kind-call-signature">process<wbr/>Federated<wbr/>Sign<wbr/>In<wbr/>Tokens</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AuthenticationTokens.html" class="tsd-signature-type tsd-kind-interface">AuthenticationTokens</a><span class="tsd-signature-symbol">&gt;</span><a href="#processFederatedSignInTokens.processFederatedSignInTokens-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
328
- <li class="tsd-description">
329
- <div class="tsd-comment tsd-typography"><p>Processes tokens from federated sign in returned to the specified URL.
68
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#presentSignOutUI">presentSignOutUI</a></p><ul><li>Defined in src/user/user-client.ts:430</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="processFederatedSignInTokens" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>process<wbr/>Federated<wbr/>Sign<wbr/>In<wbr/>Tokens</span><a href="#processFederatedSignInTokens" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="processFederatedSignInTokens.processFederatedSignInTokens-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">process<wbr/>Federated<wbr/>Sign<wbr/>In<wbr/>Tokens</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AuthenticationTokens.html" class="tsd-signature-type tsd-kind-interface">AuthenticationTokens</a><span class="tsd-signature-symbol">&gt;</span><a href="#processFederatedSignInTokens.processFederatedSignInTokens-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Processes tokens from federated sign in returned to the specified URL.
330
69
  The tokens are passed to the web app via a redirect URL.</p>
331
- </div>
332
- <div class="tsd-parameters">
333
- <h4 class="tsd-parameters-title">Parameters</h4>
334
- <ul class="tsd-parameter-list">
335
- <li>
336
- <h5><span class="tsd-kind-parameter">url</span>: <span class="tsd-signature-type">string</span></h5>
337
- <div class="tsd-comment tsd-typography"><p>callback URL containing the tokens.</p>
338
- </div>
339
- <div class="tsd-comment tsd-typography"></div></li></ul></div>
340
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AuthenticationTokens.html" class="tsd-signature-type tsd-kind-interface">AuthenticationTokens</a><span class="tsd-signature-symbol">&gt;</span></h4><p>Successful authentication result AuthenticationTokens.</p>
341
-
342
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
343
- <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#processFederatedSignInTokens">processFederatedSignInTokens</a></p>
344
- <ul>
345
- <li>Defined in src/user/user-client.ts:128</li></ul></aside></li></ul></section>
346
- <section class="tsd-panel tsd-member"><a id="refreshTokens" class="tsd-anchor"></a>
347
- <h3 class="tsd-anchor-link"><span>refresh<wbr/>Tokens</span><a href="#refreshTokens" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
348
- <ul class="tsd-signatures">
349
- <li class="tsd-signature tsd-anchor-link" id="refreshTokens.refreshTokens-1"><span class="tsd-kind-call-signature">refresh<wbr/>Tokens</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">refreshToken</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AuthenticationTokens.html" class="tsd-signature-type tsd-kind-interface">AuthenticationTokens</a><span class="tsd-signature-symbol">&gt;</span><a href="#refreshTokens.refreshTokens-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
350
- <li class="tsd-description">
351
- <div class="tsd-comment tsd-typography"><p>Refresh the access and ID tokens using the refresh token.</p>
352
- </div>
353
- <div class="tsd-parameters">
354
- <h4 class="tsd-parameters-title">Parameters</h4>
355
- <ul class="tsd-parameter-list">
356
- <li>
357
- <h5><span class="tsd-kind-parameter">refreshToken</span>: <span class="tsd-signature-type">string</span></h5>
358
- <div class="tsd-comment tsd-typography"><p>refresh token used to refresh the access and ID tokens.</p>
359
- </div>
360
- <div class="tsd-comment tsd-typography"></div></li></ul></div>
361
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AuthenticationTokens.html" class="tsd-signature-type tsd-kind-interface">AuthenticationTokens</a><span class="tsd-signature-symbol">&gt;</span></h4><p>Successful authentication result AuthenticationTokens containing refreshed tokens</p>
362
-
363
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
364
- <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#refreshTokens">refreshTokens</a></p>
365
- <ul>
366
- <li>Defined in src/user/user-client.ts:223</li></ul></aside></li></ul></section>
367
- <section class="tsd-panel tsd-member"><a id="registerWithAuthenticationProvider" class="tsd-anchor"></a>
368
- <h3 class="tsd-anchor-link"><span>register<wbr/>With<wbr/>Authentication<wbr/>Provider</span><a href="#registerWithAuthenticationProvider" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
369
- <ul class="tsd-signatures">
370
- <li class="tsd-signature tsd-anchor-link" id="registerWithAuthenticationProvider.registerWithAuthenticationProvider-1"><span class="tsd-kind-call-signature">register<wbr/>With<wbr/>Authentication<wbr/>Provider</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">authenticationProvider</span>, <span class="tsd-kind-parameter">registrationId</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#registerWithAuthenticationProvider.registerWithAuthenticationProvider-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
371
- <li class="tsd-description">
372
- <div class="tsd-comment tsd-typography"><p>Registers this client against the backend with an external authentication provider. The caller must
70
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">url</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>callback URL containing the tokens.</p>
71
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AuthenticationTokens.html" class="tsd-signature-type tsd-kind-interface">AuthenticationTokens</a><span class="tsd-signature-symbol">&gt;</span></h4><p>Successful authentication result AuthenticationTokens.</p>
72
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#processFederatedSignInTokens">processFederatedSignInTokens</a></p><ul><li>Defined in src/user/user-client.ts:128</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="refreshTokens" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>refresh<wbr/>Tokens</span><a href="#refreshTokens" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="refreshTokens.refreshTokens-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">refresh<wbr/>Tokens</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">refreshToken</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AuthenticationTokens.html" class="tsd-signature-type tsd-kind-interface">AuthenticationTokens</a><span class="tsd-signature-symbol">&gt;</span><a href="#refreshTokens.refreshTokens-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Refresh the access and ID tokens using the refresh token.</p>
73
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">refreshToken</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>refresh token used to refresh the access and ID tokens.</p>
74
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AuthenticationTokens.html" class="tsd-signature-type tsd-kind-interface">AuthenticationTokens</a><span class="tsd-signature-symbol">&gt;</span></h4><p>Successful authentication result AuthenticationTokens containing refreshed tokens</p>
75
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#refreshTokens">refreshTokens</a></p><ul><li>Defined in src/user/user-client.ts:223</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="registerWithAuthenticationProvider" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>register<wbr/>With<wbr/>Authentication<wbr/>Provider</span><a href="#registerWithAuthenticationProvider" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="registerWithAuthenticationProvider.registerWithAuthenticationProvider-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">register<wbr/>With<wbr/>Authentication<wbr/>Provider</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">authenticationProvider</span>, <span class="tsd-kind-parameter">registrationId</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#registerWithAuthenticationProvider.registerWithAuthenticationProvider-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Registers this client against the backend with an external authentication provider. The caller must
373
76
  implement AuthenticationProvider protocol to return the appropriate authentication token required
374
77
  to authorize the registration request.</p>
375
- </div>
376
- <div class="tsd-parameters">
377
- <h4 class="tsd-parameters-title">Parameters</h4>
378
- <ul class="tsd-parameter-list">
379
- <li>
380
- <h5><span class="tsd-kind-parameter">authenticationProvider</span>: <a href="../interfaces/AuthenticationProvider.html" class="tsd-signature-type tsd-kind-interface">AuthenticationProvider</a></h5>
381
- <div class="tsd-comment tsd-typography"><p>authentication provider that provides the authentication token.</p>
382
- </div>
383
- <div class="tsd-comment tsd-typography"></div></li>
384
- <li>
385
- <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">registrationId</span>: <span class="tsd-signature-type">string</span></h5>
386
- <div class="tsd-comment tsd-typography"><p>registration ID to uniquely identify this registration request.</p>
387
- </div>
388
- <div class="tsd-comment tsd-typography"></div></li></ul></div>
389
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>user ID of the newly created user</p>
390
-
391
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
392
- <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#registerWithAuthenticationProvider">registerWithAuthenticationProvider</a></p>
393
- <ul>
394
- <li>Defined in src/user/user-client.ts:303</li></ul></aside></li></ul></section>
395
- <section class="tsd-panel tsd-member"><a id="reset" class="tsd-anchor"></a>
396
- <h3 class="tsd-anchor-link"><span>reset</span><a href="#reset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
397
- <ul class="tsd-signatures">
398
- <li class="tsd-signature tsd-anchor-link" id="reset.reset-1"><span class="tsd-kind-call-signature">reset</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#reset.reset-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
399
- <li class="tsd-description">
400
- <div class="tsd-comment tsd-typography"><p>Resets internal state and clears any cached data.</p>
401
- </div>
402
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
403
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
404
- <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#reset">reset</a></p>
405
- <ul>
406
- <li>Defined in src/user/user-client.ts:435</li></ul></aside></li></ul></section>
407
- <section class="tsd-panel tsd-member"><a id="setAuthUI" class="tsd-anchor"></a>
408
- <h3 class="tsd-anchor-link"><span>set<wbr/>AuthUI</span><a href="#setAuthUI" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
409
- <ul class="tsd-signatures">
410
- <li class="tsd-signature tsd-anchor-link" id="setAuthUI.setAuthUI-1"><span class="tsd-kind-call-signature">set<wbr/>AuthUI</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">authUI</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setAuthUI.setAuthUI-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
411
- <li class="tsd-description">
412
- <div class="tsd-comment tsd-typography"><p>Provide a custom auth UI. This is mainly used for unit testing (optional).</p>
413
- </div>
414
- <div class="tsd-parameters">
415
- <h4 class="tsd-parameters-title">Parameters</h4>
416
- <ul class="tsd-parameter-list">
417
- <li>
418
- <h5><span class="tsd-kind-parameter">authUI</span>: <span class="tsd-signature-type ">AuthUI</span></h5></li></ul></div>
419
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
420
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
421
- <ul>
422
- <li>Defined in src/user/user-client.ts:534</li></ul></aside></li></ul></section>
423
- <section class="tsd-panel tsd-member"><a id="setAuthenticationStore" class="tsd-anchor"></a>
424
- <h3 class="tsd-anchor-link"><span>set<wbr/>Authentication<wbr/>Store</span><a href="#setAuthenticationStore" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
425
- <ul class="tsd-signatures">
426
- <li class="tsd-signature tsd-anchor-link" id="setAuthenticationStore.setAuthenticationStore-1"><span class="tsd-kind-call-signature">set<wbr/>Authentication<wbr/>Store</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">authenticationStore</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setAuthenticationStore.setAuthenticationStore-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
427
- <li class="tsd-description">
428
- <div class="tsd-comment tsd-typography"><p>Provide a custom authentication store.
78
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">authenticationProvider</span>: <a href="../interfaces/AuthenticationProvider.html" class="tsd-signature-type tsd-kind-interface">AuthenticationProvider</a></span><div class="tsd-comment tsd-typography"><p>authentication provider that provides the authentication token.</p>
79
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">registrationId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>registration ID to uniquely identify this registration request.</p>
80
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>user ID of the newly created user</p>
81
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#registerWithAuthenticationProvider">registerWithAuthenticationProvider</a></p><ul><li>Defined in src/user/user-client.ts:302</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="reset" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>reset</span><a href="#reset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="reset.reset-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">reset</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#reset.reset-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Resets internal state and clears any cached data.</p>
82
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#reset">reset</a></p><ul><li>Defined in src/user/user-client.ts:434</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="resetUserData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>reset<wbr/>User<wbr/>Data</span><a href="#resetUserData" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="resetUserData.resetUserData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">reset<wbr/>User<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#resetUserData.resetUserData-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Removes all data owned by the signed-in user in Sudo Platform Services
83
+ without deregistering the user.
84
+ Should only be used in tests.</p>
85
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#resetUserData">resetUserData</a></p><ul><li>Defined in src/user/user-client.ts:440</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setAuthUI" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>AuthUI</span><a href="#setAuthUI" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setAuthUI.setAuthUI-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>AuthUI</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">authUI</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setAuthUI.setAuthUI-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Provide a custom auth UI. This is mainly used for unit testing (optional).</p>
86
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">authUI</span>: <span class="tsd-signature-type">AuthUI</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in src/user/user-client.ts:541</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setAuthenticationStore" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Authentication<wbr/>Store</span><a href="#setAuthenticationStore" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setAuthenticationStore.setAuthenticationStore-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Authentication<wbr/>Store</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">authenticationStore</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setAuthenticationStore.setAuthenticationStore-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Provide a custom authentication store.
429
87
  This is mainly used for unit testing (optional).</p>
430
- </div>
431
- <div class="tsd-parameters">
432
- <h4 class="tsd-parameters-title">Parameters</h4>
433
- <ul class="tsd-parameter-list">
434
- <li>
435
- <h5><span class="tsd-kind-parameter">authenticationStore</span>: <span class="tsd-signature-type ">AuthenticationStore</span></h5></li></ul></div>
436
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
437
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
438
- <ul>
439
- <li>Defined in src/user/user-client.ts:557</li></ul></aside></li></ul></section>
440
- <section class="tsd-panel tsd-member"><a id="setIdentityProvider" class="tsd-anchor"></a>
441
- <h3 class="tsd-anchor-link"><span>set<wbr/>Identity<wbr/>Provider</span><a href="#setIdentityProvider" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
442
- <ul class="tsd-signatures">
443
- <li class="tsd-signature tsd-anchor-link" id="setIdentityProvider.setIdentityProvider-1"><span class="tsd-kind-call-signature">set<wbr/>Identity<wbr/>Provider</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">identityProvider</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setIdentityProvider.setIdentityProvider-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
444
- <li class="tsd-description">
445
- <div class="tsd-comment tsd-typography"><p>Provide a custom identity provider. This is mainly used for unit testing (optional).</p>
446
- </div>
447
- <div class="tsd-parameters">
448
- <h4 class="tsd-parameters-title">Parameters</h4>
449
- <ul class="tsd-parameter-list">
450
- <li>
451
- <h5><span class="tsd-kind-parameter">identityProvider</span>: <span class="tsd-signature-type ">IdentityProvider</span></h5></li></ul></div>
452
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
453
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
454
- <ul>
455
- <li>Defined in src/user/user-client.ts:541</li></ul></aside></li></ul></section>
456
- <section class="tsd-panel tsd-member"><a id="setLaunchUriFn" class="tsd-anchor"></a>
457
- <h3 class="tsd-anchor-link"><span>set<wbr/>Launch<wbr/>Uri<wbr/>Fn</span><a href="#setLaunchUriFn" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
458
- <ul class="tsd-signatures">
459
- <li class="tsd-signature tsd-anchor-link" id="setLaunchUriFn.setLaunchUriFn-1"><span class="tsd-kind-call-signature">set<wbr/>Launch<wbr/>Uri<wbr/>Fn</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">launchUriFn</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setLaunchUriFn.setLaunchUriFn-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
460
- <li class="tsd-description">
461
- <div class="tsd-comment tsd-typography"><p>Provide a custom function to open the sign in url.
88
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">authenticationStore</span>: <span class="tsd-signature-type">AuthenticationStore</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in src/user/user-client.ts:564</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setIdentityProvider" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Identity<wbr/>Provider</span><a href="#setIdentityProvider" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setIdentityProvider.setIdentityProvider-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Identity<wbr/>Provider</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">identityProvider</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setIdentityProvider.setIdentityProvider-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Provide a custom identity provider. This is mainly used for unit testing (optional).</p>
89
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">identityProvider</span>: <span class="tsd-signature-type">IdentityProvider</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in src/user/user-client.ts:548</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setLaunchUriFn" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Launch<wbr/>Uri<wbr/>Fn</span><a href="#setLaunchUriFn" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setLaunchUriFn.setLaunchUriFn-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Launch<wbr/>Uri<wbr/>Fn</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">launchUriFn</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setLaunchUriFn.setLaunchUriFn-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Provide a custom function to open the sign in url.
462
90
  This is mainly used for unit testing (optional).</p>
463
- </div>
464
- <div class="tsd-parameters">
465
- <h4 class="tsd-parameters-title">Parameters</h4>
466
- <ul class="tsd-parameter-list">
467
- <li>
468
- <h5><span class="tsd-kind-parameter">launchUriFn</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
469
- <ul class="tsd-parameters">
470
- <li class="tsd-parameter-signature">
471
- <ul class="tsd-signatures">
472
- <li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
473
- <li class="tsd-description">
474
- <div class="tsd-parameters">
475
- <h4 class="tsd-parameters-title">Parameters</h4>
476
- <ul class="tsd-parameter-list">
477
- <li>
478
- <h5><span class="tsd-kind-parameter">url</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
479
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
480
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
481
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
482
- <ul>
483
- <li>Defined in src/user/user-client.ts:549</li></ul></aside></li></ul></section>
484
- <section class="tsd-panel tsd-member"><a id="setUserName" class="tsd-anchor"></a>
485
- <h3 class="tsd-anchor-link"><span>set<wbr/>User<wbr/>Name</span><a href="#setUserName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
486
- <ul class="tsd-signatures">
487
- <li class="tsd-signature tsd-anchor-link" id="setUserName.setUserName-1"><span class="tsd-kind-call-signature">set<wbr/>User<wbr/>Name</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#setUserName.setUserName-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
488
- <li class="tsd-description">
489
- <div class="tsd-comment tsd-typography"><p>Sets the user name associated with this client.</p>
490
- </div>
491
- <div class="tsd-parameters">
492
- <h4 class="tsd-parameters-title">Parameters</h4>
493
- <ul class="tsd-parameter-list">
494
- <li>
495
- <h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
496
- <div class="tsd-comment tsd-typography"><p>user name.</p>
497
- </div>
498
- <div class="tsd-comment tsd-typography"></div></li></ul></div>
499
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
500
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
501
- <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#setUserName">setUserName</a></p>
502
- <ul>
503
- <li>Defined in src/user/user-client.ts:184</li></ul></aside></li></ul></section>
504
- <section class="tsd-panel tsd-member"><a id="signInWithAuthenticationProvider" class="tsd-anchor"></a>
505
- <h3 class="tsd-anchor-link"><span>sign<wbr/>In<wbr/>With<wbr/>Authentication<wbr/>Provider</span><a href="#signInWithAuthenticationProvider" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
506
- <ul class="tsd-signatures">
507
- <li class="tsd-signature tsd-anchor-link" id="signInWithAuthenticationProvider.signInWithAuthenticationProvider-1"><span class="tsd-kind-call-signature">sign<wbr/>In<wbr/>With<wbr/>Authentication<wbr/>Provider</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">authenticationProvider</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AuthenticationTokens.html" class="tsd-signature-type tsd-kind-interface">AuthenticationTokens</a><span class="tsd-signature-symbol">&gt;</span><a href="#signInWithAuthenticationProvider.signInWithAuthenticationProvider-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
508
- <li class="tsd-description">
509
- <div class="tsd-comment tsd-typography"><p>Sign into the backend using an external authentication provider. Caller must implement
91
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">launchUriFn</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></span><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">url</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in src/user/user-client.ts:556</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setUserName" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>User<wbr/>Name</span><a href="#setUserName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setUserName.setUserName-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>User<wbr/>Name</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#setUserName.setUserName-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the user name associated with this client.</p>
92
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>user name.</p>
93
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#setUserName">setUserName</a></p><ul><li>Defined in src/user/user-client.ts:184</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="signInWithAuthenticationProvider" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>sign<wbr/>In<wbr/>With<wbr/>Authentication<wbr/>Provider</span><a href="#signInWithAuthenticationProvider" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="signInWithAuthenticationProvider.signInWithAuthenticationProvider-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">sign<wbr/>In<wbr/>With<wbr/>Authentication<wbr/>Provider</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">authenticationProvider</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AuthenticationTokens.html" class="tsd-signature-type tsd-kind-interface">AuthenticationTokens</a><span class="tsd-signature-symbol">&gt;</span><a href="#signInWithAuthenticationProvider.signInWithAuthenticationProvider-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sign into the backend using an external authentication provider. Caller must implement
510
94
  <em>AuthenticationProvider</em> interface to return the appropriate authentication token associated with
511
95
  the external identity registered with <em>registerWithAuthenticationProvider</em>.</p>
512
- </div>
513
- <div class="tsd-parameters">
514
- <h4 class="tsd-parameters-title">Parameters</h4>
515
- <ul class="tsd-parameter-list">
516
- <li>
517
- <h5><span class="tsd-kind-parameter">authenticationProvider</span>: <a href="../interfaces/AuthenticationProvider.html" class="tsd-signature-type tsd-kind-interface">AuthenticationProvider</a></h5>
518
- <div class="tsd-comment tsd-typography"><p>authentication provider that provides the authentication token.</p>
519
- </div>
520
- <div class="tsd-comment tsd-typography"></div></li></ul></div>
521
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AuthenticationTokens.html" class="tsd-signature-type tsd-kind-interface">AuthenticationTokens</a><span class="tsd-signature-symbol">&gt;</span></h4><p>authentication tokens associated with the successful sign in.</p>
522
-
523
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
524
- <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#signInWithAuthenticationProvider">signInWithAuthenticationProvider</a></p>
525
- <ul>
526
- <li>Defined in src/user/user-client.ts:358</li></ul></aside></li></ul></section>
527
- <section class="tsd-panel tsd-member"><a id="signInWithKey" class="tsd-anchor"></a>
528
- <h3 class="tsd-anchor-link"><span>sign<wbr/>In<wbr/>With<wbr/>Key</span><a href="#signInWithKey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
529
- <ul class="tsd-signatures">
530
- <li class="tsd-signature tsd-anchor-link" id="signInWithKey.signInWithKey-1"><span class="tsd-kind-call-signature">sign<wbr/>In<wbr/>With<wbr/>Key</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AuthenticationTokens.html" class="tsd-signature-type tsd-kind-interface">AuthenticationTokens</a><span class="tsd-signature-symbol">&gt;</span><a href="#signInWithKey.signInWithKey-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
531
- <li class="tsd-description">
532
- <div class="tsd-comment tsd-typography"><p>Sign into the backend using a private key. The client must have created a private/public key pair via
96
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">authenticationProvider</span>: <a href="../interfaces/AuthenticationProvider.html" class="tsd-signature-type tsd-kind-interface">AuthenticationProvider</a></span><div class="tsd-comment tsd-typography"><p>authentication provider that provides the authentication token.</p>
97
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AuthenticationTokens.html" class="tsd-signature-type tsd-kind-interface">AuthenticationTokens</a><span class="tsd-signature-symbol">&gt;</span></h4><p>authentication tokens associated with the successful sign in.</p>
98
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#signInWithAuthenticationProvider">signInWithAuthenticationProvider</a></p><ul><li>Defined in src/user/user-client.ts:357</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="signInWithKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>sign<wbr/>In<wbr/>With<wbr/>Key</span><a href="#signInWithKey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="signInWithKey.signInWithKey-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">sign<wbr/>In<wbr/>With<wbr/>Key</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AuthenticationTokens.html" class="tsd-signature-type tsd-kind-interface">AuthenticationTokens</a><span class="tsd-signature-symbol">&gt;</span><a href="#signInWithKey.signInWithKey-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sign into the backend using a private key. The client must have created a private/public key pair via
533
99
  the <em>registerWithAuthenticationProvider</em> method.</p>
534
- </div>
535
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AuthenticationTokens.html" class="tsd-signature-type tsd-kind-interface">AuthenticationTokens</a><span class="tsd-signature-symbol">&gt;</span></h4><p>authentication tokens associated with the successful sign in.</p>
536
-
537
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
538
- <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#signInWithKey">signInWithKey</a></p>
539
- <ul>
540
- <li>Defined in src/user/user-client.ts:393</li></ul></aside></li></ul></section>
541
- <section class="tsd-panel tsd-member"><a id="signOut" class="tsd-anchor"></a>
542
- <h3 class="tsd-anchor-link"><span>sign<wbr/>Out</span><a href="#signOut" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
543
- <ul class="tsd-signatures">
544
- <li class="tsd-signature tsd-anchor-link" id="signOut.signOut-1"><span class="tsd-kind-call-signature">sign<wbr/>Out</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#signOut.signOut-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
545
- <li class="tsd-description">
546
- <div class="tsd-comment tsd-typography"><p>Signs out the user from this device.</p>
547
- </div>
548
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
549
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
550
- <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#signOut">signOut</a></p>
551
- <ul>
552
- <li>Defined in src/user/user-client.ts:277</li></ul></aside></li></ul></section></section></div>
553
- <div class="col-sidebar">
554
- <div class="page-menu">
555
- <div class="tsd-navigation settings">
556
- <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
557
- <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)" id="icon-chevronDown"></path></svg>Settings</h3></summary>
558
- <div class="tsd-accordion-details">
559
- <div class="tsd-filter-visibility">
560
- <h4 class="uppercase">Member Visibility</h4><form>
561
- <ul id="tsd-filter-options">
562
- <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
563
- <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
564
- <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div>
565
- <div class="tsd-theme-toggle">
566
- <h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
567
- <details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
568
- <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary>
569
- <div class="tsd-accordion-details">
570
- <ul>
571
- <li><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-512"></use></svg><span>constructor</span></a></li>
572
- <li><a href="#sudoKeyManager" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>sudo<wbr/>Key<wbr/>Manager</span></a></li>
573
- <li><a href="#clearAuthenticationTokens" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>clear<wbr/>Authentication<wbr/>Tokens</span></a></li>
574
- <li><a href="#deregister" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>deregister</span></a></li>
575
- <li><a href="#getAccessToken" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Access<wbr/>Token</span></a></li>
576
- <li><a href="#getIdToken" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Id<wbr/>Token</span></a></li>
577
- <li><a href="#getLatestAuthToken" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Latest<wbr/>Auth<wbr/>Token</span></a></li>
578
- <li><a href="#getRefreshToken" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Refresh<wbr/>Token</span></a></li>
579
- <li><a href="#getRefreshTokenExpiry" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Refresh<wbr/>Token<wbr/>Expiry</span></a></li>
580
- <li><a href="#getSubject" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Subject</span></a></li>
581
- <li><a href="#getTokenExpiry" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Token<wbr/>Expiry</span></a></li>
582
- <li><a href="#getUserClaim" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>User<wbr/>Claim</span></a></li>
583
- <li><a href="#getUserName" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>User<wbr/>Name</span></a></li>
584
- <li><a href="#globalSignOut" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>global<wbr/>Sign<wbr/>Out</span></a></li>
585
- <li><a href="#isRegistered" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Registered</span></a></li>
586
- <li><a href="#isSignedIn" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Signed<wbr/>In</span></a></li>
587
- <li><a href="#presentFederatedSignInUI" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>present<wbr/>Federated<wbr/>Sign<wbr/>InUI</span></a></li>
588
- <li><a href="#presentSignOutUI" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>present<wbr/>Sign<wbr/>OutUI</span></a></li>
589
- <li><a href="#processFederatedSignInTokens" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>process<wbr/>Federated<wbr/>Sign<wbr/>In<wbr/>Tokens</span></a></li>
590
- <li><a href="#refreshTokens" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>refresh<wbr/>Tokens</span></a></li>
591
- <li><a href="#registerWithAuthenticationProvider" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>register<wbr/>With<wbr/>Authentication<wbr/>Provider</span></a></li>
592
- <li><a href="#reset" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>reset</span></a></li>
593
- <li><a href="#setAuthUI" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>AuthUI</span></a></li>
594
- <li><a href="#setAuthenticationStore" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Authentication<wbr/>Store</span></a></li>
595
- <li><a href="#setIdentityProvider" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Identity<wbr/>Provider</span></a></li>
596
- <li><a href="#setLaunchUriFn" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Launch<wbr/>Uri<wbr/>Fn</span></a></li>
597
- <li><a href="#setUserName" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>User<wbr/>Name</span></a></li>
598
- <li><a href="#signInWithAuthenticationProvider" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>sign<wbr/>In<wbr/>With<wbr/>Authentication<wbr/>Provider</span></a></li>
599
- <li><a href="#signInWithKey" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>sign<wbr/>In<wbr/>With<wbr/>Key</span></a></li>
600
- <li><a href="#signOut" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>sign<wbr/>Out</span></a></li></ul></div></details></div>
601
- <div class="site-menu">
602
- <nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>@sudoplatform/sudo-<wbr/>user</span></a>
603
- <ul class="tsd-small-nested-navigation">
604
- <li><a href="../modules/internal.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>internal</span></a></li>
605
- <li><a href="AlreadyRegisteredError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>Already<wbr/>Registered<wbr/>Error</span></a></li>
606
- <li><a href="DefaultSudoUserClient.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Default<wbr/>Sudo<wbr/>User<wbr/>Client</span></a></li>
607
- <li><a href="IdentityServiceConfigNotFoundError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Identity<wbr/>Service<wbr/>Config<wbr/>Not<wbr/>Found<wbr/>Error</span></a></li>
608
- <li><a href="LocalAuthenticationProvider.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Local<wbr/>Authentication<wbr/>Provider</span></a></li>
609
- <li><a href="TESTAuthenticationProvider.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>TESTAuthentication<wbr/>Provider</span></a></li>
610
- <li><a href="../interfaces/AuthenticationProvider.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>Authentication<wbr/>Provider</span></a></li>
611
- <li><a href="../interfaces/AuthenticationTokens.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Authentication<wbr/>Tokens</span></a></li>
612
- <li><a href="../interfaces/SudoUserClient.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Sudo<wbr/>User<wbr/>Client</span></a></li></ul></nav></div></div></div>
613
- <div class="tsd-generator">
614
- <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
615
- <div class="overlay"></div></body></html>
100
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AuthenticationTokens.html" class="tsd-signature-type tsd-kind-interface">AuthenticationTokens</a><span class="tsd-signature-symbol">&gt;</span></h4><p>authentication tokens associated with the successful sign in.</p>
101
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#signInWithKey">signInWithKey</a></p><ul><li>Defined in src/user/user-client.ts:392</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="signOut" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>sign<wbr/>Out</span><a href="#signOut" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="signOut.signOut-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">sign<wbr/>Out</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#signOut.signOut-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Signs out the user from this device.</p>
102
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#signOut">signOut</a></p><ul><li>Defined in src/user/user-client.ts:276</li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#sudoKeyManager" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>sudo<wbr/>Key<wbr/>Manager</span></a><a href="#clearAuthenticationTokens" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clear<wbr/>Authentication<wbr/>Tokens</span></a><a href="#deregister" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>deregister</span></a><a href="#getAccessToken" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Access<wbr/>Token</span></a><a href="#getIdToken" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Id<wbr/>Token</span></a><a href="#getLatestAuthToken" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Latest<wbr/>Auth<wbr/>Token</span></a><a href="#getRefreshToken" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Refresh<wbr/>Token</span></a><a href="#getRefreshTokenExpiry" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Refresh<wbr/>Token<wbr/>Expiry</span></a><a href="#getSubject" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Subject</span></a><a href="#getTokenExpiry" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Token<wbr/>Expiry</span></a><a href="#getUserClaim" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>User<wbr/>Claim</span></a><a href="#getUserName" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>User<wbr/>Name</span></a><a href="#globalSignOut" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>global<wbr/>Sign<wbr/>Out</span></a><a href="#isRegistered" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Registered</span></a><a href="#isSignedIn" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Signed<wbr/>In</span></a><a href="#presentFederatedSignInUI" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>present<wbr/>Federated<wbr/>Sign<wbr/>InUI</span></a><a href="#presentSignOutUI" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>present<wbr/>Sign<wbr/>OutUI</span></a><a href="#processFederatedSignInTokens" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>process<wbr/>Federated<wbr/>Sign<wbr/>In<wbr/>Tokens</span></a><a href="#refreshTokens" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>refresh<wbr/>Tokens</span></a><a href="#registerWithAuthenticationProvider" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>register<wbr/>With<wbr/>Authentication<wbr/>Provider</span></a><a href="#reset" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reset</span></a><a href="#resetUserData" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reset<wbr/>User<wbr/>Data</span></a><a href="#setAuthUI" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>AuthUI</span></a><a href="#setAuthenticationStore" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Authentication<wbr/>Store</span></a><a href="#setIdentityProvider" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Identity<wbr/>Provider</span></a><a href="#setLaunchUriFn" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Launch<wbr/>Uri<wbr/>Fn</span></a><a href="#setUserName" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>User<wbr/>Name</span></a><a href="#signInWithAuthenticationProvider" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sign<wbr/>In<wbr/>With<wbr/>Authentication<wbr/>Provider</span></a><a href="#signInWithKey" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sign<wbr/>In<wbr/>With<wbr/>Key</span></a><a href="#signOut" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sign<wbr/>Out</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@sudoplatform/sudo-user</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>