@sudoplatform/sudo-user 13.0.1 → 13.0.2

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 (25) hide show
  1. package/cjs/gen/graphql-types.js.map +1 -1
  2. package/docs/assets/main.js +3 -3
  3. package/docs/assets/search.js +1 -1
  4. package/docs/assets/style.css +450 -363
  5. package/docs/classes/AlreadyRegisteredError.html +78 -70
  6. package/docs/classes/DefaultSudoUserClient.html +308 -281
  7. package/docs/classes/IdentityServiceConfigNotFoundError.html +78 -70
  8. package/docs/classes/LocalAuthenticationProvider.html +59 -52
  9. package/docs/classes/TESTAuthenticationProvider.html +67 -60
  10. package/docs/functions/internal.getIdentityServiceConfig.html +32 -26
  11. package/docs/index.html +33 -45
  12. package/docs/interfaces/AuthenticationProvider.html +41 -35
  13. package/docs/interfaces/AuthenticationTokens.html +48 -42
  14. package/docs/interfaces/SudoUserClient.html +260 -237
  15. package/docs/modules/internal.html +37 -31
  16. package/docs/modules.html +29 -34
  17. package/docs/types/internal.Config.html +30 -24
  18. package/docs/types/internal.FederatedSignInConfig.html +30 -24
  19. package/docs/types/internal.IdentityServiceConfig.html +30 -24
  20. package/docs/variables/internal.Config-1.html +30 -24
  21. package/docs/variables/internal.FederatedSignInConfigCodec.html +30 -24
  22. package/docs/variables/internal.IdentityServiceConfigCodec.html +30 -24
  23. package/lib/gen/graphql-types.js.map +1 -1
  24. package/package.json +14 -25
  25. package/types/gen/graphql-types.d.ts +70 -20
package/docs/classes/DefaultSudoUserClient.html CHANGED
@@ -1,4 +1,4 @@
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 async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
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
2
  <div class="tsd-toolbar-contents container">
3
3
  <div class="table-cell" id="tsd-search" data-base="..">
4
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>
@@ -9,7 +9,7 @@
9
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
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
11
  <div class="container container-main">
12
- <div class="col-8 col-content">
12
+ <div class="col-content">
13
13
  <div class="tsd-page-title">
14
14
  <ul class="tsd-breadcrumb">
15
15
  <li><a href="../modules.html">@sudoplatform/sudo-user</a></li>
@@ -18,7 +18,8 @@
18
18
  <section class="tsd-panel tsd-comment">
19
19
  <div class="tsd-comment tsd-typography"><p>Interface encapsulating a library of functions for calling Sudo Platform identity service,
20
20
  handling federated sign in, managing keys and performing cryptographic operations.</p>
21
- </div></section>
21
+ </div>
22
+ <div class="tsd-comment tsd-typography"></div></section>
22
23
  <section class="tsd-panel tsd-hierarchy">
23
24
  <h4>Hierarchy</h4>
24
25
  <ul class="tsd-hierarchy">
@@ -26,7 +27,7 @@ handling federated sign in, managing keys and performing cryptographic operation
26
27
  <section class="tsd-panel">
27
28
  <h4>Implements</h4>
28
29
  <ul class="tsd-hierarchy">
29
- <li><a href="../interfaces/SudoUserClient.html" class="tsd-signature-type" data-tsd-kind="Interface">SudoUserClient</a></li></ul></section><aside class="tsd-sources">
30
+ <li><a href="../interfaces/SudoUserClient.html" class="tsd-signature-type tsd-kind-interface">SudoUserClient</a></li></ul></section><aside class="tsd-sources">
30
31
  <ul>
31
32
  <li>Defined in src/user/user-client.ts:51</li></ul></aside>
32
33
  <section class="tsd-panel-group tsd-index-group">
@@ -36,192 +37,195 @@ handling federated sign in, managing keys and performing cryptographic operation
36
37
  <div class="tsd-accordion-details">
37
38
  <section class="tsd-index-section">
38
39
  <h3 class="tsd-index-heading">Constructors</h3>
39
- <div class="tsd-index-list"><a href="DefaultSudoUserClient.html#constructor" class="tsd-index-link tsd-kind-constructor tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#4D7FFF" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-512-path"></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)" id="icon-512-text"></path></svg><span>constructor</span></a>
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>
40
41
  </div></section>
41
42
  <section class="tsd-index-section">
42
43
  <h3 class="tsd-index-heading">Accessors</h3>
43
- <div class="tsd-index-list"><a href="DefaultSudoUserClient.html#sudoKeyManager" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-262144-path"></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)" id="icon-262144-text"></path></svg><span>sudo<wbr/>Key<wbr/>Manager</span></a>
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>
44
45
  </div></section>
45
46
  <section class="tsd-index-section">
46
47
  <h3 class="tsd-index-heading">Methods</h3>
47
- <div class="tsd-index-list"><a href="DefaultSudoUserClient.html#clearAuthenticationTokens" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-2048-path"></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)" id="icon-2048-text"></path></svg><span>clear<wbr/>Authentication<wbr/>Tokens</span></a>
48
- <a href="DefaultSudoUserClient.html#deregister" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>deregister</span></a>
49
- <a href="DefaultSudoUserClient.html#getAccessToken" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Access<wbr/>Token</span></a>
50
- <a href="DefaultSudoUserClient.html#getIdToken" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Id<wbr/>Token</span></a>
51
- <a href="DefaultSudoUserClient.html#getLatestAuthToken" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Latest<wbr/>Auth<wbr/>Token</span></a>
52
- <a href="DefaultSudoUserClient.html#getRefreshToken" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Refresh<wbr/>Token</span></a>
53
- <a href="DefaultSudoUserClient.html#getRefreshTokenExpiry" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Refresh<wbr/>Token<wbr/>Expiry</span></a>
54
- <a href="DefaultSudoUserClient.html#getSubject" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Subject</span></a>
55
- <a href="DefaultSudoUserClient.html#getTokenExpiry" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Token<wbr/>Expiry</span></a>
56
- <a href="DefaultSudoUserClient.html#getUserClaim" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>User<wbr/>Claim</span></a>
57
- <a href="DefaultSudoUserClient.html#getUserName" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>User<wbr/>Name</span></a>
58
- <a href="DefaultSudoUserClient.html#globalSignOut" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>global<wbr/>Sign<wbr/>Out</span></a>
59
- <a href="DefaultSudoUserClient.html#isRegistered" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>is<wbr/>Registered</span></a>
60
- <a href="DefaultSudoUserClient.html#isSignedIn" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>is<wbr/>Signed<wbr/>In</span></a>
61
- <a href="DefaultSudoUserClient.html#presentFederatedSignInUI" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>present<wbr/>Federated<wbr/>Sign<wbr/>InUI</span></a>
62
- <a href="DefaultSudoUserClient.html#presentSignOutUI" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>present<wbr/>Sign<wbr/>OutUI</span></a>
63
- <a href="DefaultSudoUserClient.html#processFederatedSignInTokens" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>process<wbr/>Federated<wbr/>Sign<wbr/>In<wbr/>Tokens</span></a>
64
- <a href="DefaultSudoUserClient.html#refreshTokens" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>refresh<wbr/>Tokens</span></a>
65
- <a href="DefaultSudoUserClient.html#registerWithAuthenticationProvider" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>register<wbr/>With<wbr/>Authentication<wbr/>Provider</span></a>
66
- <a href="DefaultSudoUserClient.html#reset" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>reset</span></a>
67
- <a href="DefaultSudoUserClient.html#setAuthUI" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>set<wbr/>AuthUI</span></a>
68
- <a href="DefaultSudoUserClient.html#setAuthenticationStore" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>set<wbr/>Authentication<wbr/>Store</span></a>
69
- <a href="DefaultSudoUserClient.html#setIdentityProvider" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>set<wbr/>Identity<wbr/>Provider</span></a>
70
- <a href="DefaultSudoUserClient.html#setLaunchUriFn" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>set<wbr/>Launch<wbr/>Uri<wbr/>Fn</span></a>
71
- <a href="DefaultSudoUserClient.html#setUserName" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>set<wbr/>User<wbr/>Name</span></a>
72
- <a href="DefaultSudoUserClient.html#signInWithAuthenticationProvider" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>sign<wbr/>In<wbr/>With<wbr/>Authentication<wbr/>Provider</span></a>
73
- <a href="DefaultSudoUserClient.html#signInWithKey" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>sign<wbr/>In<wbr/>With<wbr/>Key</span></a>
74
- <a href="DefaultSudoUserClient.html#signOut" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>sign<wbr/>Out</span></a>
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>
75
76
  </div></section></div></details></section></section>
76
77
  <section class="tsd-panel-group tsd-member-group">
77
78
  <h2>Constructors</h2>
78
- <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a>
79
- <h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></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" id="icon-anchor-c"></path></svg></a></h3>
80
- <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
81
- <li class="tsd-signature tsd-anchor-link" id="constructor.new_DefaultSudoUserClient">new <wbr/>Default<wbr/>Sudo<wbr/>User<wbr/>Client<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">SudoUserOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="DefaultSudoUserClient.html" class="tsd-signature-type" data-tsd-kind="Class">DefaultSudoUserClient</a><a href="#constructor.new_DefaultSudoUserClient" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
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>
82
83
  <li class="tsd-description">
83
84
  <div class="tsd-parameters">
84
85
  <h4 class="tsd-parameters-title">Parameters</h4>
85
86
  <ul class="tsd-parameter-list">
86
87
  <li>
87
- <h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">SudoUserOptions</span></h5></li></ul></div>
88
- <h4 class="tsd-returns-title">Returns <a href="DefaultSudoUserClient.html" class="tsd-signature-type" data-tsd-kind="Class">DefaultSudoUserClient</a></h4><aside class="tsd-sources">
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">
89
90
  <ul>
90
91
  <li>Defined in src/user/user-client.ts:62</li></ul></aside></li></ul></section></section>
91
92
  <section class="tsd-panel-group tsd-member-group">
92
93
  <h2>Accessors</h2>
93
- <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="sudoKeyManager" class="tsd-anchor"></a>
94
- <h3 class="tsd-anchor-link"><span>sudo<wbr/>Key<wbr/>Manager</span><a href="#sudoKeyManager" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
95
- <ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class">
96
- <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>
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>
97
98
  <li class="tsd-description">
98
99
  <div class="tsd-comment tsd-typography"><p>Getter to retrieve the SudoKeyManager</p>
99
100
  </div>
100
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SudoKeyManager</span></h4><aside class="tsd-sources">
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">
101
103
  <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#sudoKeyManager">sudoKeyManager</a></p>
102
104
  <ul>
103
105
  <li>Defined in src/user/user-client.ts:114</li></ul></aside></li></ul></section></section>
104
106
  <section class="tsd-panel-group tsd-member-group">
105
107
  <h2>Methods</h2>
106
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="clearAuthenticationTokens" class="tsd-anchor"></a>
107
- <h3 class="tsd-anchor-link"><span>clear<wbr/>Authentication<wbr/>Tokens</span><a href="#clearAuthenticationTokens" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
108
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
109
- <li class="tsd-signature tsd-anchor-link" id="clearAuthenticationTokens.clearAuthenticationTokens-1">clear<wbr/>Authentication<wbr/>Tokens<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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
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>
110
112
  <li class="tsd-description">
111
113
  <div class="tsd-comment tsd-typography"><p>Clears cached authentication tokens.</p>
112
114
  </div>
113
- <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><aside class="tsd-sources">
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">
114
117
  <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#clearAuthenticationTokens">clearAuthenticationTokens</a></p>
115
118
  <ul>
116
119
  <li>Defined in src/user/user-client.ts:418</li></ul></aside></li></ul></section>
117
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deregister" class="tsd-anchor"></a>
118
- <h3 class="tsd-anchor-link"><span>deregister</span><a href="#deregister" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
119
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
120
- <li class="tsd-signature tsd-anchor-link" id="deregister.deregister-1">deregister<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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
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>
121
124
  <li class="tsd-description">
122
125
  <div class="tsd-comment tsd-typography"><p>De-registers the user associated with this client. The user must
123
126
  be signed in.</p>
124
127
  </div>
125
- <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><aside class="tsd-sources">
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">
126
130
  <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#deregister">deregister</a></p>
127
131
  <ul>
128
132
  <li>Defined in src/user/user-client.ts:412</li></ul></aside></li></ul></section>
129
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getAccessToken" class="tsd-anchor"></a>
130
- <h3 class="tsd-anchor-link"><span>get<wbr/>Access<wbr/>Token</span><a href="#getAccessToken" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
131
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
132
- <li class="tsd-signature tsd-anchor-link" id="getAccessToken.getAccessToken-1">get<wbr/>Access<wbr/>Token<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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
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>
133
137
  <li class="tsd-description">
134
138
  <div class="tsd-comment tsd-typography"><p>Returns the access token cached from the last sign-in.</p>
135
-
136
- <h3>Returns</h3><p>access token.</p>
137
139
  </div>
138
- <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><aside class="tsd-sources">
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">
139
143
  <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getAccessToken">getAccessToken</a></p>
140
144
  <ul>
141
145
  <li>Defined in src/user/user-client.ts:152</li></ul></aside></li></ul></section>
142
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getIdToken" class="tsd-anchor"></a>
143
- <h3 class="tsd-anchor-link"><span>get<wbr/>Id<wbr/>Token</span><a href="#getIdToken" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
144
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
145
- <li class="tsd-signature tsd-anchor-link" id="getIdToken.getIdToken-1">get<wbr/>Id<wbr/>Token<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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
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>
146
150
  <li class="tsd-description">
147
151
  <div class="tsd-comment tsd-typography"><p>Returns the ID token cached from the last sign-in.</p>
148
-
149
- <h3>Returns</h3><p>ID token.</p>
150
152
  </div>
151
- <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><aside class="tsd-sources">
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">
152
156
  <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getIdToken">getIdToken</a></p>
153
157
  <ul>
154
158
  <li>Defined in src/user/user-client.ts:148</li></ul></aside></li></ul></section>
155
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getLatestAuthToken" class="tsd-anchor"></a>
156
- <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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
157
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
158
- <li class="tsd-signature tsd-anchor-link" id="getLatestAuthToken.getLatestAuthToken-1">get<wbr/>Latest<wbr/>Auth<wbr/>Token<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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
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>
159
163
  <li class="tsd-description">
160
164
  <div class="tsd-comment tsd-typography"><p>Retrieves the latest ID token. This is to be used by the AWS AppSync client.</p>
161
-
162
- <h3>Returns</h3><p>the latest ID token</p>
163
165
  </div>
164
- <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><aside class="tsd-sources">
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">
165
169
  <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getLatestAuthToken">getLatestAuthToken</a></p>
166
170
  <ul>
167
171
  <li>Defined in src/user/user-client.ts:243</li></ul></aside></li></ul></section>
168
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getRefreshToken" class="tsd-anchor"></a>
169
- <h3 class="tsd-anchor-link"><span>get<wbr/>Refresh<wbr/>Token</span><a href="#getRefreshToken" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
170
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
171
- <li class="tsd-signature tsd-anchor-link" id="getRefreshToken.getRefreshToken-1">get<wbr/>Refresh<wbr/>Token<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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
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>
172
176
  <li class="tsd-description">
173
177
  <div class="tsd-comment tsd-typography"><p>Returns the refresh token cached from the last sign-in.</p>
174
-
175
- <h3>Returns</h3><p>refresh token.</p>
176
178
  </div>
177
- <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><aside class="tsd-sources">
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">
178
182
  <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getRefreshToken">getRefreshToken</a></p>
179
183
  <ul>
180
184
  <li>Defined in src/user/user-client.ts:156</li></ul></aside></li></ul></section>
181
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getRefreshTokenExpiry" class="tsd-anchor"></a>
182
- <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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
183
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
184
- <li class="tsd-signature tsd-anchor-link" id="getRefreshTokenExpiry.getRefreshTokenExpiry-1">get<wbr/>Refresh<wbr/>Token<wbr/>Expiry<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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
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>
185
189
  <li class="tsd-description">
186
190
  <div class="tsd-comment tsd-typography"><p>Returns the refresh token expiry cached from the last sign-in.</p>
187
-
188
- <h3>Returns</h3><p>refresh token expiry.</p>
189
191
  </div>
190
- <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><aside class="tsd-sources">
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">
191
195
  <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getRefreshTokenExpiry">getRefreshTokenExpiry</a></p>
192
196
  <ul>
193
197
  <li>Defined in src/user/user-client.ts:165</li></ul></aside></li></ul></section>
194
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getSubject" class="tsd-anchor"></a>
195
- <h3 class="tsd-anchor-link"><span>get<wbr/>Subject</span><a href="#getSubject" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
196
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
197
- <li class="tsd-signature tsd-anchor-link" id="getSubject.getSubject-1">get<wbr/>Subject<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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
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>
198
202
  <li class="tsd-description">
199
203
  <div class="tsd-comment tsd-typography"><p>Returns the subject of the user associated with this client.
200
204
  Note: This is an internal method used by other Sudo platform SDKs.</p>
201
-
202
- <h3>Returns</h3><p>user subject.</p>
203
205
  </div>
204
- <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><aside class="tsd-sources">
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">
205
209
  <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getSubject">getSubject</a></p>
206
210
  <ul>
207
211
  <li>Defined in src/user/user-client.ts:195</li></ul></aside></li></ul></section>
208
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getTokenExpiry" class="tsd-anchor"></a>
209
- <h3 class="tsd-anchor-link"><span>get<wbr/>Token<wbr/>Expiry</span><a href="#getTokenExpiry" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
210
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
211
- <li class="tsd-signature tsd-anchor-link" id="getTokenExpiry.getTokenExpiry-1">get<wbr/>Token<wbr/>Expiry<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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
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>
212
216
  <li class="tsd-description">
213
217
  <div class="tsd-comment tsd-typography"><p>Returns the ID and access token expiry cached from the last sign-in.</p>
214
-
215
- <h3>Returns</h3><p>token expiry.</p>
216
218
  </div>
217
- <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><aside class="tsd-sources">
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">
218
222
  <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getTokenExpiry">getTokenExpiry</a></p>
219
223
  <ul>
220
224
  <li>Defined in src/user/user-client.ts:160</li></ul></aside></li></ul></section>
221
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getUserClaim" class="tsd-anchor"></a>
222
- <h3 class="tsd-anchor-link"><span>get<wbr/>User<wbr/>Claim</span><a href="#getUserClaim" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
223
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
224
- <li class="tsd-signature tsd-anchor-link" id="getUserClaim.getUserClaim-1">get<wbr/>User<wbr/>Claim<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
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>
225
229
  <li class="tsd-description">
226
230
  <div class="tsd-comment tsd-typography"><p>Returns the specified claim associated with the user&#39;s identity.</p>
227
231
  </div>
@@ -229,171 +233,181 @@ Note: This is an internal method used by other Sudo platform SDKs.</p>
229
233
  <h4 class="tsd-parameters-title">Parameters</h4>
230
234
  <ul class="tsd-parameter-list">
231
235
  <li>
232
- <h5>name: <span class="tsd-signature-type">string</span></h5>
236
+ <h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
233
237
  <div class="tsd-comment tsd-typography"><p>claim name.</p>
234
- </div></li></ul></div>
235
- <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><aside class="tsd-sources">
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">
236
242
  <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getUserClaim">getUserClaim</a></p>
237
243
  <ul>
238
244
  <li>Defined in src/user/user-client.ts:189</li></ul></aside></li></ul></section>
239
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getUserName" class="tsd-anchor"></a>
240
- <h3 class="tsd-anchor-link"><span>get<wbr/>User<wbr/>Name</span><a href="#getUserName" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
241
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
242
- <li class="tsd-signature tsd-anchor-link" id="getUserName.getUserName-1">get<wbr/>User<wbr/>Name<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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
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>
243
249
  <li class="tsd-description">
244
250
  <div class="tsd-comment tsd-typography"><p>Returns the user name associated with this client. The username maybe needed to contact
245
251
  the support team when diagnosing an issue related to a specific user.</p>
246
-
247
- <h3>Returns</h3><p>user name.</p>
248
252
  </div>
249
- <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><aside class="tsd-sources">
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">
250
256
  <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getUserName">getUserName</a></p>
251
257
  <ul>
252
258
  <li>Defined in src/user/user-client.ts:176</li></ul></aside></li></ul></section>
253
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="globalSignOut" class="tsd-anchor"></a>
254
- <h3 class="tsd-anchor-link"><span>global<wbr/>Sign<wbr/>Out</span><a href="#globalSignOut" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
255
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
256
- <li class="tsd-signature tsd-anchor-link" id="globalSignOut.globalSignOut-1">global<wbr/>Sign<wbr/>Out<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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
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>
257
263
  <li class="tsd-description">
258
264
  <div class="tsd-comment tsd-typography"><p>Signs out the user from all devices.</p>
259
265
  </div>
260
- <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><aside class="tsd-sources">
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">
261
268
  <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#globalSignOut">globalSignOut</a></p>
262
269
  <ul>
263
270
  <li>Defined in src/user/user-client.ts:295</li></ul></aside></li></ul></section>
264
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="isRegistered" class="tsd-anchor"></a>
265
- <h3 class="tsd-anchor-link"><span>is<wbr/>Registered</span><a href="#isRegistered" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
266
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
267
- <li class="tsd-signature tsd-anchor-link" id="isRegistered.isRegistered-1">is<wbr/>Registered<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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
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>
268
275
  <li class="tsd-description">
269
276
  <div class="tsd-comment tsd-typography"><p>Indicates whether or not this client is registered with Sudo Platform backend.</p>
270
-
271
- <h3>Returns</h3><p><em>true</em> if the client is registered.</p>
272
277
  </div>
273
- <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><aside class="tsd-sources">
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">
274
281
  <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#isRegistered">isRegistered</a></p>
275
282
  <ul>
276
283
  <li>Defined in src/user/user-client.ts:384</li></ul></aside></li></ul></section>
277
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="isSignedIn" class="tsd-anchor"></a>
278
- <h3 class="tsd-anchor-link"><span>is<wbr/>Signed<wbr/>In</span><a href="#isSignedIn" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
279
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
280
- <li class="tsd-signature tsd-anchor-link" id="isSignedIn.isSignedIn-1">is<wbr/>Signed<wbr/>In<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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
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>
281
288
  <li class="tsd-description">
282
289
  <div class="tsd-comment tsd-typography"><p>Indicates whether or not this client is signed in with Sudo Platform backend. The client is
283
290
  considered signed in if it cached valid ID, access and refresh tokens.</p>
284
-
285
- <h3>Returns</h3><p><em>true</em> if the client is signed in.</p>
286
291
  </div>
287
- <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><aside class="tsd-sources">
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">
288
295
  <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#isSignedIn">isSignedIn</a></p>
289
296
  <ul>
290
297
  <li>Defined in src/user/user-client.ts:199</li></ul></aside></li></ul></section>
291
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="presentFederatedSignInUI" class="tsd-anchor"></a>
292
- <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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
293
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
294
- <li class="tsd-signature tsd-anchor-link" id="presentFederatedSignInUI.presentFederatedSignInUI-1">present<wbr/>Federated<wbr/>Sign<wbr/>InUI<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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
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>
295
302
  <li class="tsd-description">
296
303
  <div class="tsd-comment tsd-typography"><p>Presents the sign in UI for federated sign in using an external identity provider.</p>
297
304
  </div>
298
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
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">
299
307
  <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#presentFederatedSignInUI">presentFederatedSignInUI</a></p>
300
308
  <ul>
301
309
  <li>Defined in src/user/user-client.ts:118</li></ul></aside></li></ul></section>
302
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="presentSignOutUI" class="tsd-anchor"></a>
303
- <h3 class="tsd-anchor-link"><span>present<wbr/>Sign<wbr/>OutUI</span><a href="#presentSignOutUI" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
304
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
305
- <li class="tsd-signature tsd-anchor-link" id="presentSignOutUI.presentSignOutUI-1">present<wbr/>Sign<wbr/>OutUI<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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
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>
306
314
  <li class="tsd-description">
307
315
  <div class="tsd-comment tsd-typography"><p>Presents the Cognito hosted UI signout endpoint.
308
316
  When the endpoint is invoked, the hosted web app&#39;s cookies
309
317
  will be invalidated, but the user is not logged out of Cognito.</p>
310
318
  </div>
311
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
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">
312
321
  <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#presentSignOutUI">presentSignOutUI</a></p>
313
322
  <ul>
314
323
  <li>Defined in src/user/user-client.ts:431</li></ul></aside></li></ul></section>
315
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="processFederatedSignInTokens" class="tsd-anchor"></a>
316
- <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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
317
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
318
- <li class="tsd-signature tsd-anchor-link" id="processFederatedSignInTokens.processFederatedSignInTokens-1">process<wbr/>Federated<wbr/>Sign<wbr/>In<wbr/>Tokens<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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" data-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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
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>
319
328
  <li class="tsd-description">
320
329
  <div class="tsd-comment tsd-typography"><p>Processes tokens from federated sign in returned to the specified URL.
321
330
  The tokens are passed to the web app via a redirect URL.</p>
322
-
323
- <h3>Returns</h3><p>Successful authentication result AuthenticationTokens.</p>
324
331
  </div>
325
332
  <div class="tsd-parameters">
326
333
  <h4 class="tsd-parameters-title">Parameters</h4>
327
334
  <ul class="tsd-parameter-list">
328
335
  <li>
329
- <h5>url: <span class="tsd-signature-type">string</span></h5>
336
+ <h5><span class="tsd-kind-parameter">url</span>: <span class="tsd-signature-type">string</span></h5>
330
337
  <div class="tsd-comment tsd-typography"><p>callback URL containing the tokens.</p>
331
- </div></li></ul></div>
332
- <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" data-tsd-kind="Interface">AuthenticationTokens</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
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">
333
343
  <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#processFederatedSignInTokens">processFederatedSignInTokens</a></p>
334
344
  <ul>
335
345
  <li>Defined in src/user/user-client.ts:128</li></ul></aside></li></ul></section>
336
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="refreshTokens" class="tsd-anchor"></a>
337
- <h3 class="tsd-anchor-link"><span>refresh<wbr/>Tokens</span><a href="#refreshTokens" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
338
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
339
- <li class="tsd-signature tsd-anchor-link" id="refreshTokens.refreshTokens-1">refresh<wbr/>Tokens<span class="tsd-signature-symbol">(</span>refreshToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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" data-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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
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>
340
350
  <li class="tsd-description">
341
351
  <div class="tsd-comment tsd-typography"><p>Refresh the access and ID tokens using the refresh token.</p>
342
-
343
- <h3>Returns</h3><p>Successful authentication result AuthenticationTokens containing refreshed tokens</p>
344
352
  </div>
345
353
  <div class="tsd-parameters">
346
354
  <h4 class="tsd-parameters-title">Parameters</h4>
347
355
  <ul class="tsd-parameter-list">
348
356
  <li>
349
- <h5>refreshToken: <span class="tsd-signature-type">string</span></h5>
357
+ <h5><span class="tsd-kind-parameter">refreshToken</span>: <span class="tsd-signature-type">string</span></h5>
350
358
  <div class="tsd-comment tsd-typography"><p>refresh token used to refresh the access and ID tokens.</p>
351
- </div></li></ul></div>
352
- <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" data-tsd-kind="Interface">AuthenticationTokens</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
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">
353
364
  <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#refreshTokens">refreshTokens</a></p>
354
365
  <ul>
355
366
  <li>Defined in src/user/user-client.ts:223</li></ul></aside></li></ul></section>
356
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="registerWithAuthenticationProvider" class="tsd-anchor"></a>
357
- <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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
358
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
359
- <li class="tsd-signature tsd-anchor-link" id="registerWithAuthenticationProvider.registerWithAuthenticationProvider-1">register<wbr/>With<wbr/>Authentication<wbr/>Provider<span class="tsd-signature-symbol">(</span>authenticationProvider<span class="tsd-signature-symbol">: </span><a href="../interfaces/AuthenticationProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationProvider</a>, registrationId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
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>
360
371
  <li class="tsd-description">
361
372
  <div class="tsd-comment tsd-typography"><p>Registers this client against the backend with an external authentication provider. The caller must
362
373
  implement AuthenticationProvider protocol to return the appropriate authentication token required
363
374
  to authorize the registration request.</p>
364
-
365
- <h3>Returns</h3><p>user ID of the newly created user</p>
366
375
  </div>
367
376
  <div class="tsd-parameters">
368
377
  <h4 class="tsd-parameters-title">Parameters</h4>
369
378
  <ul class="tsd-parameter-list">
370
379
  <li>
371
- <h5>authenticationProvider: <a href="../interfaces/AuthenticationProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationProvider</a></h5>
380
+ <h5><span class="tsd-kind-parameter">authenticationProvider</span>: <a href="../interfaces/AuthenticationProvider.html" class="tsd-signature-type tsd-kind-interface">AuthenticationProvider</a></h5>
372
381
  <div class="tsd-comment tsd-typography"><p>authentication provider that provides the authentication token.</p>
373
- </div></li>
382
+ </div>
383
+ <div class="tsd-comment tsd-typography"></div></li>
374
384
  <li>
375
- <h5><code class="tsd-tag ts-flagOptional">Optional</code> registrationId: <span class="tsd-signature-type">string</span></h5>
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>
376
386
  <div class="tsd-comment tsd-typography"><p>registration ID to uniquely identify this registration request.</p>
377
- </div></li></ul></div>
378
- <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><aside class="tsd-sources">
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">
379
392
  <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#registerWithAuthenticationProvider">registerWithAuthenticationProvider</a></p>
380
393
  <ul>
381
394
  <li>Defined in src/user/user-client.ts:303</li></ul></aside></li></ul></section>
382
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="reset" class="tsd-anchor"></a>
383
- <h3 class="tsd-anchor-link"><span>reset</span><a href="#reset" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
384
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
385
- <li class="tsd-signature tsd-anchor-link" id="reset.reset-1">reset<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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
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>
386
399
  <li class="tsd-description">
387
400
  <div class="tsd-comment tsd-typography"><p>Resets internal state and clears any cached data.</p>
388
401
  </div>
389
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
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">
390
404
  <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#reset">reset</a></p>
391
405
  <ul>
392
406
  <li>Defined in src/user/user-client.ts:435</li></ul></aside></li></ul></section>
393
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setAuthUI" class="tsd-anchor"></a>
394
- <h3 class="tsd-anchor-link"><span>set<wbr/>AuthUI</span><a href="#setAuthUI" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
395
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
396
- <li class="tsd-signature tsd-anchor-link" id="setAuthUI.setAuthUI-1">set<wbr/>AuthUI<span class="tsd-signature-symbol">(</span>authUI<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
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>
397
411
  <li class="tsd-description">
398
412
  <div class="tsd-comment tsd-typography"><p>Provide a custom auth UI. This is mainly used for unit testing (optional).</p>
399
413
  </div>
@@ -401,14 +415,15 @@ to authorize the registration request.</p>
401
415
  <h4 class="tsd-parameters-title">Parameters</h4>
402
416
  <ul class="tsd-parameter-list">
403
417
  <li>
404
- <h5>authUI: <span class="tsd-signature-type">AuthUI</span></h5></li></ul></div>
405
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
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">
406
421
  <ul>
407
422
  <li>Defined in src/user/user-client.ts:534</li></ul></aside></li></ul></section>
408
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setAuthenticationStore" class="tsd-anchor"></a>
409
- <h3 class="tsd-anchor-link"><span>set<wbr/>Authentication<wbr/>Store</span><a href="#setAuthenticationStore" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
410
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
411
- <li class="tsd-signature tsd-anchor-link" id="setAuthenticationStore.setAuthenticationStore-1">set<wbr/>Authentication<wbr/>Store<span class="tsd-signature-symbol">(</span>authenticationStore<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
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>
412
427
  <li class="tsd-description">
413
428
  <div class="tsd-comment tsd-typography"><p>Provide a custom authentication store.
414
429
  This is mainly used for unit testing (optional).</p>
@@ -417,14 +432,15 @@ This is mainly used for unit testing (optional).</p>
417
432
  <h4 class="tsd-parameters-title">Parameters</h4>
418
433
  <ul class="tsd-parameter-list">
419
434
  <li>
420
- <h5>authenticationStore: <span class="tsd-signature-type">AuthenticationStore</span></h5></li></ul></div>
421
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
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">
422
438
  <ul>
423
439
  <li>Defined in src/user/user-client.ts:557</li></ul></aside></li></ul></section>
424
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setIdentityProvider" class="tsd-anchor"></a>
425
- <h3 class="tsd-anchor-link"><span>set<wbr/>Identity<wbr/>Provider</span><a href="#setIdentityProvider" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
426
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
427
- <li class="tsd-signature tsd-anchor-link" id="setIdentityProvider.setIdentityProvider-1">set<wbr/>Identity<wbr/>Provider<span class="tsd-signature-symbol">(</span>identityProvider<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
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>
428
444
  <li class="tsd-description">
429
445
  <div class="tsd-comment tsd-typography"><p>Provide a custom identity provider. This is mainly used for unit testing (optional).</p>
430
446
  </div>
@@ -432,14 +448,15 @@ This is mainly used for unit testing (optional).</p>
432
448
  <h4 class="tsd-parameters-title">Parameters</h4>
433
449
  <ul class="tsd-parameter-list">
434
450
  <li>
435
- <h5>identityProvider: <span class="tsd-signature-type">IdentityProvider</span></h5></li></ul></div>
436
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
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">
437
454
  <ul>
438
455
  <li>Defined in src/user/user-client.ts:541</li></ul></aside></li></ul></section>
439
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setLaunchUriFn" class="tsd-anchor"></a>
440
- <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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
441
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
442
- <li class="tsd-signature tsd-anchor-link" id="setLaunchUriFn.setLaunchUriFn-1">set<wbr/>Launch<wbr/>Uri<wbr/>Fn<span class="tsd-signature-symbol">(</span>launchUriFn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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 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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
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>
443
460
  <li class="tsd-description">
444
461
  <div class="tsd-comment tsd-typography"><p>Provide a custom function to open the sign in url.
445
462
  This is mainly used for unit testing (optional).</p>
@@ -448,25 +465,26 @@ This is mainly used for unit testing (optional).</p>
448
465
  <h4 class="tsd-parameters-title">Parameters</h4>
449
466
  <ul class="tsd-parameter-list">
450
467
  <li>
451
- <h5>launchUriFn: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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>
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>
452
469
  <ul class="tsd-parameters">
453
470
  <li class="tsd-parameter-signature">
454
- <ul class="tsd-signatures tsd-kind-type-literal">
455
- <li class="tsd-signature"><span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
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>
456
473
  <li class="tsd-description">
457
474
  <div class="tsd-parameters">
458
475
  <h4 class="tsd-parameters-title">Parameters</h4>
459
476
  <ul class="tsd-parameter-list">
460
477
  <li>
461
- <h5>url: <span class="tsd-signature-type">string</span></h5></li></ul></div>
478
+ <h5><span class="tsd-kind-parameter">url</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
462
479
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
463
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
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">
464
482
  <ul>
465
483
  <li>Defined in src/user/user-client.ts:549</li></ul></aside></li></ul></section>
466
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setUserName" class="tsd-anchor"></a>
467
- <h3 class="tsd-anchor-link"><span>set<wbr/>User<wbr/>Name</span><a href="#setUserName" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
468
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
469
- <li class="tsd-signature tsd-anchor-link" id="setUserName.setUserName-1">set<wbr/>User<wbr/>Name<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
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>
470
488
  <li class="tsd-description">
471
489
  <div class="tsd-comment tsd-typography"><p>Sets the user name associated with this client.</p>
472
490
  </div>
@@ -474,64 +492,69 @@ This is mainly used for unit testing (optional).</p>
474
492
  <h4 class="tsd-parameters-title">Parameters</h4>
475
493
  <ul class="tsd-parameter-list">
476
494
  <li>
477
- <h5>name: <span class="tsd-signature-type">string</span></h5>
495
+ <h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
478
496
  <div class="tsd-comment tsd-typography"><p>user name.</p>
479
- </div></li></ul></div>
480
- <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><aside class="tsd-sources">
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">
481
501
  <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#setUserName">setUserName</a></p>
482
502
  <ul>
483
503
  <li>Defined in src/user/user-client.ts:184</li></ul></aside></li></ul></section>
484
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="signInWithAuthenticationProvider" class="tsd-anchor"></a>
485
- <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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
486
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
487
- <li class="tsd-signature tsd-anchor-link" id="signInWithAuthenticationProvider.signInWithAuthenticationProvider-1">sign<wbr/>In<wbr/>With<wbr/>Authentication<wbr/>Provider<span class="tsd-signature-symbol">(</span>authenticationProvider<span class="tsd-signature-symbol">: </span><a href="../interfaces/AuthenticationProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationProvider</a><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" data-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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
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>
488
508
  <li class="tsd-description">
489
509
  <div class="tsd-comment tsd-typography"><p>Sign into the backend using an external authentication provider. Caller must implement
490
510
  <em>AuthenticationProvider</em> interface to return the appropriate authentication token associated with
491
511
  the external identity registered with <em>registerWithAuthenticationProvider</em>.</p>
492
-
493
- <h3>Returns</h3><p>authentication tokens associated with the successful sign in.</p>
494
512
  </div>
495
513
  <div class="tsd-parameters">
496
514
  <h4 class="tsd-parameters-title">Parameters</h4>
497
515
  <ul class="tsd-parameter-list">
498
516
  <li>
499
- <h5>authenticationProvider: <a href="../interfaces/AuthenticationProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">AuthenticationProvider</a></h5>
517
+ <h5><span class="tsd-kind-parameter">authenticationProvider</span>: <a href="../interfaces/AuthenticationProvider.html" class="tsd-signature-type tsd-kind-interface">AuthenticationProvider</a></h5>
500
518
  <div class="tsd-comment tsd-typography"><p>authentication provider that provides the authentication token.</p>
501
- </div></li></ul></div>
502
- <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" data-tsd-kind="Interface">AuthenticationTokens</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
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">
503
524
  <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#signInWithAuthenticationProvider">signInWithAuthenticationProvider</a></p>
504
525
  <ul>
505
526
  <li>Defined in src/user/user-client.ts:358</li></ul></aside></li></ul></section>
506
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="signInWithKey" class="tsd-anchor"></a>
507
- <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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
508
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
509
- <li class="tsd-signature tsd-anchor-link" id="signInWithKey.signInWithKey-1">sign<wbr/>In<wbr/>With<wbr/>Key<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" data-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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
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>
510
531
  <li class="tsd-description">
511
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
512
533
  the <em>registerWithAuthenticationProvider</em> method.</p>
513
-
514
- <h3>Returns</h3><p>authentication tokens associated with the successful sign in.</p>
515
534
  </div>
516
- <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" data-tsd-kind="Interface">AuthenticationTokens</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
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">
517
538
  <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#signInWithKey">signInWithKey</a></p>
518
539
  <ul>
519
540
  <li>Defined in src/user/user-client.ts:393</li></ul></aside></li></ul></section>
520
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="signOut" class="tsd-anchor"></a>
521
- <h3 class="tsd-anchor-link"><span>sign<wbr/>Out</span><a href="#signOut" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
522
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
523
- <li class="tsd-signature tsd-anchor-link" id="signOut.signOut-1">sign<wbr/>Out<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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
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>
524
545
  <li class="tsd-description">
525
546
  <div class="tsd-comment tsd-typography"><p>Signs out the user from this device.</p>
526
547
  </div>
527
- <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><aside class="tsd-sources">
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">
528
550
  <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#signOut">signOut</a></p>
529
551
  <ul>
530
552
  <li>Defined in src/user/user-client.ts:277</li></ul></aside></li></ul></section></section></div>
531
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
553
+ <div class="col-sidebar">
554
+ <div class="page-menu">
532
555
  <div class="tsd-navigation settings">
533
556
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
534
- <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)"></path></svg> Settings</h3></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>
535
558
  <div class="tsd-accordion-details">
536
559
  <div class="tsd-filter-visibility">
537
560
  <h4 class="uppercase">Member Visibility</h4><form>
@@ -540,49 +563,53 @@ the <em>registerWithAuthenticationProvider</em> method.</p>
540
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>
541
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>
542
565
  <div class="tsd-theme-toggle">
543
- <h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
544
- <nav class="tsd-navigation primary">
545
- <details class="tsd-index-accordion" open><summary class="tsd-accordion-summary">
546
- <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)"></path></svg> Modules</h3></summary>
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>
547
569
  <div class="tsd-accordion-details">
548
570
  <ul>
549
- <li><a href="../modules.html">@sudoplatform/sudo-<wbr/>user</a>
550
- <ul>
551
- <li class="tsd-kind-namespace"><a href="../modules/internal.html">internal</a></li></ul></li></ul></div></details></nav>
552
- <nav class="tsd-navigation secondary menu-sticky">
553
- <ul>
554
- <li class="current tsd-kind-class"><a href="DefaultSudoUserClient.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><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" id="icon-128-path"></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)" id="icon-128-text"></path></svg><span>Default<wbr/>Sudo<wbr/>User<wbr/>Client</span></a>
555
- <ul>
556
- <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-512-path"></use><use href="#icon-512-text"></use></svg>constructor</a></li>
557
- <li class="tsd-kind-accessor tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#sudoKeyManager" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>sudo<wbr/>Key<wbr/>Manager</a></li>
558
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#clearAuthenticationTokens" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>clear<wbr/>Authentication<wbr/>Tokens</a></li>
559
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#deregister" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>deregister</a></li>
560
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#getAccessToken" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Access<wbr/>Token</a></li>
561
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#getIdToken" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Id<wbr/>Token</a></li>
562
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#getLatestAuthToken" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Latest<wbr/>Auth<wbr/>Token</a></li>
563
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#getRefreshToken" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Refresh<wbr/>Token</a></li>
564
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#getRefreshTokenExpiry" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Refresh<wbr/>Token<wbr/>Expiry</a></li>
565
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#getSubject" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Subject</a></li>
566
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#getTokenExpiry" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Token<wbr/>Expiry</a></li>
567
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#getUserClaim" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>User<wbr/>Claim</a></li>
568
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#getUserName" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>User<wbr/>Name</a></li>
569
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#globalSignOut" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>global<wbr/>Sign<wbr/>Out</a></li>
570
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#isRegistered" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>is<wbr/>Registered</a></li>
571
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#isSignedIn" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>is<wbr/>Signed<wbr/>In</a></li>
572
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#presentFederatedSignInUI" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>present<wbr/>Federated<wbr/>Sign<wbr/>InUI</a></li>
573
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#presentSignOutUI" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>present<wbr/>Sign<wbr/>OutUI</a></li>
574
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#processFederatedSignInTokens" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>process<wbr/>Federated<wbr/>Sign<wbr/>In<wbr/>Tokens</a></li>
575
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#refreshTokens" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>refresh<wbr/>Tokens</a></li>
576
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#registerWithAuthenticationProvider" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>register<wbr/>With<wbr/>Authentication<wbr/>Provider</a></li>
577
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#reset" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>reset</a></li>
578
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#setAuthUI" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>set<wbr/>AuthUI</a></li>
579
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#setAuthenticationStore" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>set<wbr/>Authentication<wbr/>Store</a></li>
580
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#setIdentityProvider" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>set<wbr/>Identity<wbr/>Provider</a></li>
581
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#setLaunchUriFn" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>set<wbr/>Launch<wbr/>Uri<wbr/>Fn</a></li>
582
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#setUserName" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>set<wbr/>User<wbr/>Name</a></li>
583
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#signInWithAuthenticationProvider" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>sign<wbr/>In<wbr/>With<wbr/>Authentication<wbr/>Provider</a></li>
584
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#signInWithKey" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>sign<wbr/>In<wbr/>With<wbr/>Key</a></li>
585
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="DefaultSudoUserClient.html#signOut" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>sign<wbr/>Out</a></li></ul></li></ul></nav></div></div>
586
- <div class="container tsd-generator">
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">
587
614
  <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
588
- <div class="overlay"></div><script src="../assets/main.js"></script></body></html>
615
+ <div class="overlay"></div></body></html>