@sudoplatform/sudo-user 17.1.0 → 17.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (161) hide show
  1. package/cjs/client/amplifyClient.js +0 -1
  2. package/cjs/client/apiClient.js +0 -1
  3. package/cjs/client/graphqlClient.js +0 -1
  4. package/cjs/client/transformer/ErrorTransformer.js +0 -1
  5. package/cjs/core/api-key-names.js +0 -1
  6. package/cjs/core/auth-store.js +0 -1
  7. package/cjs/core/crypto.js +0 -1
  8. package/cjs/core/key-manager.js +0 -1
  9. package/cjs/core/protected-store.js +0 -1
  10. package/cjs/core/publisher.js +0 -1
  11. package/cjs/core/sdk-config.js +0 -1
  12. package/cjs/core/subscriber.js +0 -1
  13. package/cjs/gen/graphql-types.js +0 -1
  14. package/cjs/index.js +0 -1
  15. package/cjs/runtimes/browser/browser-crypto.js +0 -1
  16. package/cjs/runtimes/node/node-crypto.js +0 -1
  17. package/cjs/sdk.js +0 -1
  18. package/cjs/user/auth-provider.js +0 -1
  19. package/cjs/user/auth.js +0 -1
  20. package/cjs/user/error.js +10 -2
  21. package/cjs/user/identity-provider.js +0 -1
  22. package/cjs/user/sign-in-callback.js +0 -1
  23. package/cjs/user/sign-in-guard.js +0 -1
  24. package/cjs/user/user-client-interface.js +0 -1
  25. package/cjs/user/user-client.js +48 -33
  26. package/cjs/user/user-key-names.js +0 -1
  27. package/cjs/utils/jwt.js +0 -1
  28. package/cjs/utils/parse-token.js +0 -1
  29. package/cjs/utils/resolvable-promise.js +0 -1
  30. package/cjs/utils/sign-options-builder.js +0 -1
  31. package/docs/assets/hierarchy.js +1 -1
  32. package/docs/assets/highlight.css +1 -1
  33. package/docs/assets/icons.js +1 -1
  34. package/docs/assets/icons.svg +1 -1
  35. package/docs/assets/main.js +4 -4
  36. package/docs/assets/navigation.js +1 -1
  37. package/docs/assets/search.js +1 -1
  38. package/docs/assets/style.css +18 -3
  39. package/docs/classes/AlreadyRegisteredError.html +148 -8
  40. package/docs/classes/AlreadySignedInError.html +173 -0
  41. package/docs/classes/DefaultSudoUserClient.html +543 -57
  42. package/docs/classes/IdentityServiceConfigNotFoundError.html +148 -8
  43. package/docs/classes/LocalAuthenticationProvider.html +123 -12
  44. package/docs/classes/SignInGuard.html +107 -8
  45. package/docs/classes/TESTAuthenticationProvider.html +138 -12
  46. package/docs/classes/internal.AmplifyClient.html +148 -13
  47. package/docs/enums/GraphQLClientAuthMode.html +64 -2
  48. package/docs/functions/internal.getIdentityServiceConfig.html +39 -1
  49. package/docs/hierarchy.html +42 -1
  50. package/docs/index.html +37 -2
  51. package/docs/interfaces/AuthenticationProvider.html +78 -5
  52. package/docs/interfaces/AuthenticationTokens.html +86 -7
  53. package/docs/interfaces/GraphQLClient.html +123 -12
  54. package/docs/interfaces/GraphQLClientOptions.html +92 -8
  55. package/docs/interfaces/SudoPlatformSignInCallback.html +68 -5
  56. package/docs/interfaces/SudoUserClient.html +431 -52
  57. package/docs/interfaces/internal.SudoUserOptions.html +91 -2
  58. package/docs/modules/internal.html +53 -1
  59. package/docs/modules.html +52 -1
  60. package/docs/types/IAMCredentials.html +65 -2
  61. package/docs/types/TokenProvider.html +33 -1
  62. package/docs/types/internal.Config.html +35 -1
  63. package/docs/types/internal.FederatedSignInConfig.html +34 -1
  64. package/docs/types/internal.IdentityServiceConfig.html +34 -1
  65. package/docs/variables/internal.Config.html +35 -1
  66. package/docs/variables/internal.FederatedSignInConfigCodec.html +34 -1
  67. package/docs/variables/internal.IdentityServiceConfigCodec.html +34 -1
  68. package/lib/client/amplifyClient.js +0 -1
  69. package/lib/client/apiClient.js +0 -1
  70. package/lib/client/graphqlClient.js +0 -1
  71. package/lib/client/transformer/ErrorTransformer.js +0 -1
  72. package/lib/core/api-key-names.js +0 -1
  73. package/lib/core/auth-store.js +0 -1
  74. package/lib/core/crypto.js +0 -1
  75. package/lib/core/key-manager.js +0 -1
  76. package/lib/core/protected-store.js +0 -1
  77. package/lib/core/publisher.js +0 -1
  78. package/lib/core/sdk-config.js +0 -1
  79. package/lib/core/subscriber.js +0 -1
  80. package/lib/gen/graphql-types.js +0 -1
  81. package/lib/index.js +0 -1
  82. package/lib/runtimes/browser/browser-crypto.js +0 -1
  83. package/lib/runtimes/node/node-crypto.js +0 -1
  84. package/lib/sdk.js +0 -1
  85. package/lib/user/auth-provider.js +0 -1
  86. package/lib/user/auth.js +0 -1
  87. package/lib/user/error.js +8 -1
  88. package/lib/user/identity-provider.js +0 -1
  89. package/lib/user/sign-in-callback.js +0 -1
  90. package/lib/user/sign-in-guard.js +0 -1
  91. package/lib/user/user-client-interface.js +0 -1
  92. package/lib/user/user-client.js +49 -34
  93. package/lib/user/user-key-names.js +0 -1
  94. package/lib/utils/jwt.js +0 -1
  95. package/lib/utils/parse-token.js +0 -1
  96. package/lib/utils/resolvable-promise.js +0 -1
  97. package/lib/utils/sign-options-builder.js +0 -1
  98. package/package.json +36 -35
  99. package/types/user/error.d.ts +6 -0
  100. package/types/user/user-client-interface.d.ts +12 -0
  101. package/types/user/user-client.d.ts +1 -0
  102. package/cjs/client/amplifyClient.js.map +0 -1
  103. package/cjs/client/apiClient.js.map +0 -1
  104. package/cjs/client/graphqlClient.js.map +0 -1
  105. package/cjs/client/transformer/ErrorTransformer.js.map +0 -1
  106. package/cjs/core/api-key-names.js.map +0 -1
  107. package/cjs/core/auth-store.js.map +0 -1
  108. package/cjs/core/crypto.js.map +0 -1
  109. package/cjs/core/key-manager.js.map +0 -1
  110. package/cjs/core/protected-store.js.map +0 -1
  111. package/cjs/core/publisher.js.map +0 -1
  112. package/cjs/core/sdk-config.js.map +0 -1
  113. package/cjs/core/subscriber.js.map +0 -1
  114. package/cjs/gen/graphql-types.js.map +0 -1
  115. package/cjs/index.js.map +0 -1
  116. package/cjs/runtimes/browser/browser-crypto.js.map +0 -1
  117. package/cjs/runtimes/node/node-crypto.js.map +0 -1
  118. package/cjs/sdk.js.map +0 -1
  119. package/cjs/user/auth-provider.js.map +0 -1
  120. package/cjs/user/auth.js.map +0 -1
  121. package/cjs/user/error.js.map +0 -1
  122. package/cjs/user/identity-provider.js.map +0 -1
  123. package/cjs/user/sign-in-callback.js.map +0 -1
  124. package/cjs/user/sign-in-guard.js.map +0 -1
  125. package/cjs/user/user-client-interface.js.map +0 -1
  126. package/cjs/user/user-client.js.map +0 -1
  127. package/cjs/user/user-key-names.js.map +0 -1
  128. package/cjs/utils/jwt.js.map +0 -1
  129. package/cjs/utils/parse-token.js.map +0 -1
  130. package/cjs/utils/resolvable-promise.js.map +0 -1
  131. package/cjs/utils/sign-options-builder.js.map +0 -1
  132. package/lib/client/amplifyClient.js.map +0 -1
  133. package/lib/client/apiClient.js.map +0 -1
  134. package/lib/client/graphqlClient.js.map +0 -1
  135. package/lib/client/transformer/ErrorTransformer.js.map +0 -1
  136. package/lib/core/api-key-names.js.map +0 -1
  137. package/lib/core/auth-store.js.map +0 -1
  138. package/lib/core/crypto.js.map +0 -1
  139. package/lib/core/key-manager.js.map +0 -1
  140. package/lib/core/protected-store.js.map +0 -1
  141. package/lib/core/publisher.js.map +0 -1
  142. package/lib/core/sdk-config.js.map +0 -1
  143. package/lib/core/subscriber.js.map +0 -1
  144. package/lib/gen/graphql-types.js.map +0 -1
  145. package/lib/index.js.map +0 -1
  146. package/lib/runtimes/browser/browser-crypto.js.map +0 -1
  147. package/lib/runtimes/node/node-crypto.js.map +0 -1
  148. package/lib/sdk.js.map +0 -1
  149. package/lib/user/auth-provider.js.map +0 -1
  150. package/lib/user/auth.js.map +0 -1
  151. package/lib/user/error.js.map +0 -1
  152. package/lib/user/identity-provider.js.map +0 -1
  153. package/lib/user/sign-in-callback.js.map +0 -1
  154. package/lib/user/sign-in-guard.js.map +0 -1
  155. package/lib/user/user-client-interface.js.map +0 -1
  156. package/lib/user/user-client.js.map +0 -1
  157. package/lib/user/user-key-names.js.map +0 -1
  158. package/lib/utils/jwt.js.map +0 -1
  159. package/lib/utils/parse-token.js.map +0 -1
  160. package/lib/utils/resolvable-promise.js.map +0 -1
  161. package/lib/utils/sign-options-builder.js.map +0 -1
package/docs/classes/DefaultSudoUserClient.html CHANGED
@@ -1,8 +1,41 @@
1
- <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DefaultSudoUserClient | @sudoplatform/sudo-user</title><meta name="description" content="Documentation for @sudoplatform/sudo-user"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@sudoplatform/sudo-user</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">DefaultSudoUserClient</a></li></ul><h1>Class DefaultSudoUserClient</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Interface encapsulating a library of functions for calling Sudo Platform identity service,
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DefaultSudoUserClient | @sudoplatform/sudo-user</title><meta name="description" content="Documentation for @sudoplatform/sudo-user"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
2
+ <div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@sudoplatform/sudo-user</a>
3
+ <div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
4
+ <ul role="listbox" id="tsd-search-results"></ul>
5
+ <div id="tsd-search-status" aria-live="polite" aria-atomic="true">
6
+ <div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
7
+ <div class="container container-main">
8
+ <div class="col-content">
9
+ <div class="tsd-page-title">
10
+ <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
11
+ <li><a href="" aria-current="page">DefaultSudoUserClient</a></li></ul>
12
+ <h1>Class DefaultSudoUserClient</h1></div>
13
+ <section class="tsd-panel tsd-comment">
14
+ <div class="tsd-comment tsd-typography"><p>Interface encapsulating a library of functions for calling Sudo Platform identity service,
2
15
  handling federated sign in, managing keys and performing cryptographic operations.</p>
3
- </div></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/SudoUserClient.html" class="tsd-signature-type tsd-kind-interface">SudoUserClient</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/72cd12f9f9bec77ccf225c79dca7e850cb25ba57/src/user/user-client.ts#L51">src/user/user-client.ts:51</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
4
- </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="#sudokeymanager" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>sudo<wbr/>Key<wbr/>Manager</span></a>
5
- </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#clearauthenticationtokens" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clear<wbr/>Authentication<wbr/>Tokens</span></a>
16
+ </div></section>
17
+ <section class="tsd-panel">
18
+ <h4>Implements</h4>
19
+ <ul class="tsd-hierarchy">
20
+ <li><a href="../interfaces/SudoUserClient.html" class="tsd-signature-type tsd-kind-interface">SudoUserClient</a></li></ul></section><aside class="tsd-sources">
21
+ <ul>
22
+ <li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/e9ea129dc5195b2e28a6cfc8cb56acd7a815b9e6/src/user/user-client.ts#L51">src/user/user-client.ts:51</a></li></ul></aside>
23
+ <section class="tsd-panel-group tsd-index-group">
24
+ <section class="tsd-panel tsd-index-panel">
25
+ <details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
26
+ <h5 class="tsd-index-heading uppercase">Index</h5></summary>
27
+ <div class="tsd-accordion-details">
28
+ <section class="tsd-index-section">
29
+ <h3 class="tsd-index-heading tsd-anchor-link" id="constructors">Constructors<a href="#constructors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
30
+ <div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
31
+ </div></section>
32
+ <section class="tsd-index-section">
33
+ <h3 class="tsd-index-heading tsd-anchor-link" id="accessors">Accessors<a href="#accessors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
34
+ <div class="tsd-index-list"><a href="#sudokeymanager" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>sudo<wbr/>Key<wbr/>Manager</span></a>
35
+ </div></section>
36
+ <section class="tsd-index-section">
37
+ <h3 class="tsd-index-heading tsd-anchor-link" id="methods">Methods<a href="#methods" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
38
+ <div class="tsd-index-list"><a href="#clearauthenticationtokens" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clear<wbr/>Authentication<wbr/>Tokens</span></a>
6
39
  <a href="#deregister" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>deregister</span></a>
7
40
  <a href="#getaccesstoken" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Access<wbr/>Token</span></a>
8
41
  <a href="#getidtoken" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Id<wbr/>Token</span></a>
@@ -28,75 +61,528 @@ handling federated sign in, managing keys and performing cryptographic operation
28
61
  <a href="#setidentityprovider" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Identity<wbr/>Provider</span></a>
29
62
  <a href="#setlaunchurifn" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Launch<wbr/>Uri<wbr/>Fn</span></a>
30
63
  <a href="#setusername" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>User<wbr/>Name</span></a>
64
+ <a href="#signinviaassumption" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sign<wbr/>In<wbr/>Via<wbr/>Assumption</span></a>
31
65
  <a href="#signinwithauthenticationprovider" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sign<wbr/>In<wbr/>With<wbr/>Authentication<wbr/>Provider</span></a>
32
66
  <a href="#signinwithkey" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sign<wbr/>In<wbr/>With<wbr/>Key</span></a>
33
67
  <a href="#signout" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sign<wbr/>Out</span></a>
34
- </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructordefaultsudouserclient"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">DefaultSudoUserClient</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/internal.SudoUserOptions.html" class="tsd-signature-type tsd-kind-interface">SudoUserOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DefaultSudoUserClient</a><a href="#constructordefaultsudouserclient" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/internal.SudoUserOptions.html" class="tsd-signature-type tsd-kind-interface">SudoUserOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DefaultSudoUserClient</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/72cd12f9f9bec77ccf225c79dca7e850cb25ba57/src/user/user-client.ts#L62">src/user/user-client.ts:62</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Accessors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="sudokeymanager"><span>sudo<wbr/>Key<wbr/>Manager</span><a href="#sudokeymanager" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="sudokeymanagersudokeymanager"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">sudoKeyManager</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">SudoKeyManager</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Getter to retrieve the SudoKeyManager</p>
35
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SudoKeyManager</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#sudokeymanager">sudoKeyManager</a></p><ul><li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/72cd12f9f9bec77ccf225c79dca7e850cb25ba57/src/user/user-client.ts#L114">src/user/user-client.ts:114</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="clearauthenticationtokens"><span>clear<wbr/>Authentication<wbr/>Tokens</span><a href="#clearauthenticationtokens" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="clearauthenticationtokens-1"><span class="tsd-kind-call-signature">clearAuthenticationTokens</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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Clears cached authentication tokens.</p>
36
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#clearauthenticationtokens">clearAuthenticationTokens</a></p><ul><li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/72cd12f9f9bec77ccf225c79dca7e850cb25ba57/src/user/user-client.ts#L417">src/user/user-client.ts:417</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deregister"><span>deregister</span><a href="#deregister" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="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-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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>De-registers the user associated with this client. The user must
68
+ </div></section></div></details></section></section>
69
+ <details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
70
+ <h2 class="tsd-anchor-link" id="constructors-1">Constructors<a href="#constructors-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
71
+ <section>
72
+ <section class="tsd-panel tsd-member">
73
+ <h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
74
+ <ul class="tsd-signatures">
75
+ <li class="">
76
+ <div class="tsd-signature tsd-anchor-link" id="constructordefaultsudouserclient"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">DefaultSudoUserClient</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/internal.SudoUserOptions.html" class="tsd-signature-type tsd-kind-interface">SudoUserOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">DefaultSudoUserClient</a><a href="#constructordefaultsudouserclient" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
77
+ <div class="tsd-description">
78
+ <div class="tsd-parameters">
79
+ <h4 class="tsd-parameters-title">Parameters</h4>
80
+ <ul class="tsd-parameter-list">
81
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/internal.SudoUserOptions.html" class="tsd-signature-type tsd-kind-interface">SudoUserOptions</a></span></li></ul></div>
82
+ <h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">DefaultSudoUserClient</a></h4><aside class="tsd-sources">
83
+ <ul>
84
+ <li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/e9ea129dc5195b2e28a6cfc8cb56acd7a815b9e6/src/user/user-client.ts#L62">src/user/user-client.ts:62</a></li></ul></aside></div></li></ul></section></section></details>
85
+ <details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
86
+ <h2 class="tsd-anchor-link" id="accessors-1">Accessors<a href="#accessors-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
87
+ <section>
88
+ <section class="tsd-panel tsd-member">
89
+ <h3 class="tsd-anchor-link" id="sudokeymanager"><span>sudo<wbr/>Key<wbr/>Manager</span><a href="#sudokeymanager" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
90
+ <ul class="tsd-signatures">
91
+ <li>
92
+ <div class="tsd-signature" id="sudokeymanagersudokeymanager"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">sudoKeyManager</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">SudoKeyManager</span></div>
93
+ <div class="tsd-description">
94
+ <div class="tsd-comment tsd-typography"><p>Getter to retrieve the SudoKeyManager</p>
95
+ </div>
96
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SudoKeyManager</span></h4><aside class="tsd-sources">
97
+ <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#sudokeymanager">sudoKeyManager</a></p>
98
+ <ul>
99
+ <li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/e9ea129dc5195b2e28a6cfc8cb56acd7a815b9e6/src/user/user-client.ts#L114">src/user/user-client.ts:114</a></li></ul></aside></div></li></ul></section></section></details>
100
+ <details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
101
+ <h2 class="tsd-anchor-link" id="methods-1">Methods<a href="#methods-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
102
+ <section>
103
+ <section class="tsd-panel tsd-member">
104
+ <h3 class="tsd-anchor-link" id="clearauthenticationtokens"><span>clear<wbr/>Authentication<wbr/>Tokens</span><a href="#clearauthenticationtokens" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
105
+ <ul class="tsd-signatures">
106
+ <li class="">
107
+ <div class="tsd-signature tsd-anchor-link" id="clearauthenticationtokens-1"><span class="tsd-kind-call-signature">clearAuthenticationTokens</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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
108
+ <div class="tsd-description">
109
+ <div class="tsd-comment tsd-typography"><p>Clears cached authentication tokens.</p>
110
+ </div>
111
+ <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">
112
+ <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#clearauthenticationtokens">clearAuthenticationTokens</a></p>
113
+ <ul>
114
+ <li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/e9ea129dc5195b2e28a6cfc8cb56acd7a815b9e6/src/user/user-client.ts#L434">src/user/user-client.ts:434</a></li></ul></aside></div></li></ul></section>
115
+ <section class="tsd-panel tsd-member">
116
+ <h3 class="tsd-anchor-link" id="deregister"><span>deregister</span><a href="#deregister" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
117
+ <ul class="tsd-signatures">
118
+ <li class="">
119
+ <div class="tsd-signature tsd-anchor-link" id="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-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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
120
+ <div class="tsd-description">
121
+ <div class="tsd-comment tsd-typography"><p>De-registers the user associated with this client. The user must
37
122
  be signed in.</p>
38
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#deregister">deregister</a></p><ul><li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/72cd12f9f9bec77ccf225c79dca7e850cb25ba57/src/user/user-client.ts#L411">src/user/user-client.ts:411</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getaccesstoken"><span>get<wbr/>Access<wbr/>Token</span><a href="#getaccesstoken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getaccesstoken-1"><span class="tsd-kind-call-signature">getAccessToken</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">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span><a href="#getaccesstoken-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the access token cached from the last sign-in.</p>
39
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span></h4><p>access token.</p>
40
- <aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getaccesstoken">getAccessToken</a></p><ul><li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/72cd12f9f9bec77ccf225c79dca7e850cb25ba57/src/user/user-client.ts#L152">src/user/user-client.ts:152</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getidtoken"><span>get<wbr/>Id<wbr/>Token</span><a href="#getidtoken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getidtoken-1"><span class="tsd-kind-call-signature">getIdToken</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">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span><a href="#getidtoken-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the ID token cached from the last sign-in.</p>
41
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span></h4><p>ID token.</p>
42
- <aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getidtoken">getIdToken</a></p><ul><li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/72cd12f9f9bec77ccf225c79dca7e850cb25ba57/src/user/user-client.ts#L148">src/user/user-client.ts:148</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getlatestauthtoken"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getlatestauthtoken-1"><span class="tsd-kind-call-signature">getLatestAuthToken</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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves the latest ID token. This is to be used by the AWS AppSync client.</p>
43
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the latest ID token</p>
44
- <aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getlatestauthtoken">getLatestAuthToken</a></p><ul><li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/72cd12f9f9bec77ccf225c79dca7e850cb25ba57/src/user/user-client.ts#L242">src/user/user-client.ts:242</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getrefreshtoken"><span>get<wbr/>Refresh<wbr/>Token</span><a href="#getrefreshtoken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getrefreshtoken-1"><span class="tsd-kind-call-signature">getRefreshToken</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">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span><a href="#getrefreshtoken-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the refresh token cached from the last sign-in.</p>
45
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span></h4><p>refresh token.</p>
46
- <aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getrefreshtoken">getRefreshToken</a></p><ul><li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/72cd12f9f9bec77ccf225c79dca7e850cb25ba57/src/user/user-client.ts#L156">src/user/user-client.ts:156</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getrefreshtokenexpiry"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getrefreshtokenexpiry-1"><span class="tsd-kind-call-signature">getRefreshTokenExpiry</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">Date</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span><a href="#getrefreshtokenexpiry-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the refresh token expiry cached from the last sign-in.</p>
47
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Date</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span></h4><p>refresh token expiry.</p>
48
- <aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getrefreshtokenexpiry">getRefreshTokenExpiry</a></p><ul><li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/72cd12f9f9bec77ccf225c79dca7e850cb25ba57/src/user/user-client.ts#L165">src/user/user-client.ts:165</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getsubject"><span>get<wbr/>Subject</span><a href="#getsubject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getsubject-1"><span class="tsd-kind-call-signature">getSubject</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">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span><a href="#getsubject-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the subject of the user associated with this client.
123
+ </div>
124
+ <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">
125
+ <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#deregister">deregister</a></p>
126
+ <ul>
127
+ <li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/e9ea129dc5195b2e28a6cfc8cb56acd7a815b9e6/src/user/user-client.ts#L428">src/user/user-client.ts:428</a></li></ul></aside></div></li></ul></section>
128
+ <section class="tsd-panel tsd-member">
129
+ <h3 class="tsd-anchor-link" id="getaccesstoken"><span>get<wbr/>Access<wbr/>Token</span><a href="#getaccesstoken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
130
+ <ul class="tsd-signatures">
131
+ <li class="">
132
+ <div class="tsd-signature tsd-anchor-link" id="getaccesstoken-1"><span class="tsd-kind-call-signature">getAccessToken</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">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span><a href="#getaccesstoken-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
133
+ <div class="tsd-description">
134
+ <div class="tsd-comment tsd-typography"><p>Returns the access token cached from the last sign-in.</p>
135
+ </div>
136
+ <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">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span></h4><p>access token.</p>
137
+ <aside class="tsd-sources">
138
+ <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getaccesstoken">getAccessToken</a></p>
139
+ <ul>
140
+ <li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/e9ea129dc5195b2e28a6cfc8cb56acd7a815b9e6/src/user/user-client.ts#L152">src/user/user-client.ts:152</a></li></ul></aside></div></li></ul></section>
141
+ <section class="tsd-panel tsd-member">
142
+ <h3 class="tsd-anchor-link" id="getidtoken"><span>get<wbr/>Id<wbr/>Token</span><a href="#getidtoken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
143
+ <ul class="tsd-signatures">
144
+ <li class="">
145
+ <div class="tsd-signature tsd-anchor-link" id="getidtoken-1"><span class="tsd-kind-call-signature">getIdToken</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">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span><a href="#getidtoken-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
146
+ <div class="tsd-description">
147
+ <div class="tsd-comment tsd-typography"><p>Returns the ID token cached from the last sign-in.</p>
148
+ </div>
149
+ <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">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span></h4><p>ID token.</p>
150
+ <aside class="tsd-sources">
151
+ <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getidtoken">getIdToken</a></p>
152
+ <ul>
153
+ <li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/e9ea129dc5195b2e28a6cfc8cb56acd7a815b9e6/src/user/user-client.ts#L148">src/user/user-client.ts:148</a></li></ul></aside></div></li></ul></section>
154
+ <section class="tsd-panel tsd-member">
155
+ <h3 class="tsd-anchor-link" id="getlatestauthtoken"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
156
+ <ul class="tsd-signatures">
157
+ <li class="">
158
+ <div class="tsd-signature tsd-anchor-link" id="getlatestauthtoken-1"><span class="tsd-kind-call-signature">getLatestAuthToken</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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
159
+ <div class="tsd-description">
160
+ <div class="tsd-comment tsd-typography"><p>Retrieves the latest ID token. This is to be used by the AWS AppSync client.</p>
161
+ </div>
162
+ <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>
163
+ <aside class="tsd-sources">
164
+ <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getlatestauthtoken">getLatestAuthToken</a></p>
165
+ <ul>
166
+ <li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/e9ea129dc5195b2e28a6cfc8cb56acd7a815b9e6/src/user/user-client.ts#L257">src/user/user-client.ts:257</a></li></ul></aside></div></li></ul></section>
167
+ <section class="tsd-panel tsd-member">
168
+ <h3 class="tsd-anchor-link" id="getrefreshtoken"><span>get<wbr/>Refresh<wbr/>Token</span><a href="#getrefreshtoken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
169
+ <ul class="tsd-signatures">
170
+ <li class="">
171
+ <div class="tsd-signature tsd-anchor-link" id="getrefreshtoken-1"><span class="tsd-kind-call-signature">getRefreshToken</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">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span><a href="#getrefreshtoken-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
172
+ <div class="tsd-description">
173
+ <div class="tsd-comment tsd-typography"><p>Returns the refresh token cached from the last sign-in.</p>
174
+ </div>
175
+ <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">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span></h4><p>refresh token.</p>
176
+ <aside class="tsd-sources">
177
+ <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getrefreshtoken">getRefreshToken</a></p>
178
+ <ul>
179
+ <li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/e9ea129dc5195b2e28a6cfc8cb56acd7a815b9e6/src/user/user-client.ts#L156">src/user/user-client.ts:156</a></li></ul></aside></div></li></ul></section>
180
+ <section class="tsd-panel tsd-member">
181
+ <h3 class="tsd-anchor-link" id="getrefreshtokenexpiry"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
182
+ <ul class="tsd-signatures">
183
+ <li class="">
184
+ <div class="tsd-signature tsd-anchor-link" id="getrefreshtokenexpiry-1"><span class="tsd-kind-call-signature">getRefreshTokenExpiry</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">Date</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span><a href="#getrefreshtokenexpiry-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
185
+ <div class="tsd-description">
186
+ <div class="tsd-comment tsd-typography"><p>Returns the refresh token expiry cached from the last sign-in.</p>
187
+ </div>
188
+ <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">Date</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span></h4><p>refresh token expiry.</p>
189
+ <aside class="tsd-sources">
190
+ <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getrefreshtokenexpiry">getRefreshTokenExpiry</a></p>
191
+ <ul>
192
+ <li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/e9ea129dc5195b2e28a6cfc8cb56acd7a815b9e6/src/user/user-client.ts#L165">src/user/user-client.ts:165</a></li></ul></aside></div></li></ul></section>
193
+ <section class="tsd-panel tsd-member">
194
+ <h3 class="tsd-anchor-link" id="getsubject"><span>get<wbr/>Subject</span><a href="#getsubject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
195
+ <ul class="tsd-signatures">
196
+ <li class="">
197
+ <div class="tsd-signature tsd-anchor-link" id="getsubject-1"><span class="tsd-kind-call-signature">getSubject</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">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span><a href="#getsubject-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
198
+ <div class="tsd-description">
199
+ <div class="tsd-comment tsd-typography"><p>Returns the subject of the user associated with this client.
49
200
  Note: This is an internal method used by other Sudo platform SDKs.</p>
50
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span></h4><p>user subject.</p>
51
- <aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getsubject">getSubject</a></p><ul><li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/72cd12f9f9bec77ccf225c79dca7e850cb25ba57/src/user/user-client.ts#L195">src/user/user-client.ts:195</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="gettokenexpiry"><span>get<wbr/>Token<wbr/>Expiry</span><a href="#gettokenexpiry" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="gettokenexpiry-1"><span class="tsd-kind-call-signature">getTokenExpiry</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">Date</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span><a href="#gettokenexpiry-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the ID and access token expiry cached from the last sign-in.</p>
52
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Date</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span></h4><p>token expiry.</p>
53
- <aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#gettokenexpiry">getTokenExpiry</a></p><ul><li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/72cd12f9f9bec77ccf225c79dca7e850cb25ba57/src/user/user-client.ts#L160">src/user/user-client.ts:160</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getuserclaim"><span>get<wbr/>User<wbr/>Claim</span><a href="#getuserclaim" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getuserclaim-1"><span class="tsd-kind-call-signature">getUserClaim</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the specified claim associated with the user's identity.</p>
54
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>claim name.</p>
55
- </div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getuserclaim">getUserClaim</a></p><ul><li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/72cd12f9f9bec77ccf225c79dca7e850cb25ba57/src/user/user-client.ts#L189">src/user/user-client.ts:189</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getusername"><span>get<wbr/>User<wbr/>Name</span><a href="#getusername" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getusername-1"><span class="tsd-kind-call-signature">getUserName</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">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span><a href="#getusername-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the user name associated with this client. The username maybe needed to contact
201
+ </div>
202
+ <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">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span></h4><p>user subject.</p>
203
+ <aside class="tsd-sources">
204
+ <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getsubject">getSubject</a></p>
205
+ <ul>
206
+ <li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/e9ea129dc5195b2e28a6cfc8cb56acd7a815b9e6/src/user/user-client.ts#L210">src/user/user-client.ts:210</a></li></ul></aside></div></li></ul></section>
207
+ <section class="tsd-panel tsd-member">
208
+ <h3 class="tsd-anchor-link" id="gettokenexpiry"><span>get<wbr/>Token<wbr/>Expiry</span><a href="#gettokenexpiry" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
209
+ <ul class="tsd-signatures">
210
+ <li class="">
211
+ <div class="tsd-signature tsd-anchor-link" id="gettokenexpiry-1"><span class="tsd-kind-call-signature">getTokenExpiry</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">Date</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span><a href="#gettokenexpiry-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
212
+ <div class="tsd-description">
213
+ <div class="tsd-comment tsd-typography"><p>Returns the ID and access token expiry cached from the last sign-in.</p>
214
+ </div>
215
+ <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">Date</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span></h4><p>token expiry.</p>
216
+ <aside class="tsd-sources">
217
+ <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#gettokenexpiry">getTokenExpiry</a></p>
218
+ <ul>
219
+ <li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/e9ea129dc5195b2e28a6cfc8cb56acd7a815b9e6/src/user/user-client.ts#L160">src/user/user-client.ts:160</a></li></ul></aside></div></li></ul></section>
220
+ <section class="tsd-panel tsd-member">
221
+ <h3 class="tsd-anchor-link" id="getuserclaim"><span>get<wbr/>User<wbr/>Claim</span><a href="#getuserclaim" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
222
+ <ul class="tsd-signatures">
223
+ <li class="">
224
+ <div class="tsd-signature tsd-anchor-link" id="getuserclaim-1"><span class="tsd-kind-call-signature">getUserClaim</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
225
+ <div class="tsd-description">
226
+ <div class="tsd-comment tsd-typography"><p>Returns the specified claim associated with the user's identity.</p>
227
+ </div>
228
+ <div class="tsd-parameters">
229
+ <h4 class="tsd-parameters-title">Parameters</h4>
230
+ <ul class="tsd-parameter-list">
231
+ <li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span>
232
+ <div class="tsd-comment tsd-typography"><p>claim name.</p>
233
+ </div></li></ul></div>
234
+ <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">
235
+ <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getuserclaim">getUserClaim</a></p>
236
+ <ul>
237
+ <li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/e9ea129dc5195b2e28a6cfc8cb56acd7a815b9e6/src/user/user-client.ts#L204">src/user/user-client.ts:204</a></li></ul></aside></div></li></ul></section>
238
+ <section class="tsd-panel tsd-member">
239
+ <h3 class="tsd-anchor-link" id="getusername"><span>get<wbr/>User<wbr/>Name</span><a href="#getusername" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
240
+ <ul class="tsd-signatures">
241
+ <li class="">
242
+ <div class="tsd-signature tsd-anchor-link" id="getusername-1"><span class="tsd-kind-call-signature">getUserName</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">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span><a href="#getusername-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
243
+ <div class="tsd-description">
244
+ <div class="tsd-comment tsd-typography"><p>Returns the user name associated with this client. The username maybe needed to contact
56
245
  the support team when diagnosing an issue related to a specific user.</p>
57
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span></h4><p>user name.</p>
58
- <aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getusername">getUserName</a></p><ul><li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/72cd12f9f9bec77ccf225c79dca7e850cb25ba57/src/user/user-client.ts#L176">src/user/user-client.ts:176</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="globalsignout"><span>global<wbr/>Sign<wbr/>Out</span><a href="#globalsignout" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="globalsignout-1"><span class="tsd-kind-call-signature">globalSignOut</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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Signs out the user from all devices.</p>
59
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#globalsignout">globalSignOut</a></p><ul><li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/72cd12f9f9bec77ccf225c79dca7e850cb25ba57/src/user/user-client.ts#L294">src/user/user-client.ts:294</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="isregistered"><span>is<wbr/>Registered</span><a href="#isregistered" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="isregistered-1"><span class="tsd-kind-call-signature">isRegistered</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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Indicates whether or not this client is registered with Sudo Platform backend.</p>
60
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4><p><em>true</em> if the client is registered.</p>
61
- <aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#isregistered">isRegistered</a></p><ul><li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/72cd12f9f9bec77ccf225c79dca7e850cb25ba57/src/user/user-client.ts#L383">src/user/user-client.ts:383</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="issignedin"><span>is<wbr/>Signed<wbr/>In</span><a href="#issignedin" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="issignedin-1"><span class="tsd-kind-call-signature">isSignedIn</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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Indicates whether or not this client is signed in with Sudo Platform backend. The client is
246
+ </div>
247
+ <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">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span></h4><p>user name.</p>
248
+ <aside class="tsd-sources">
249
+ <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#getusername">getUserName</a></p>
250
+ <ul>
251
+ <li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/e9ea129dc5195b2e28a6cfc8cb56acd7a815b9e6/src/user/user-client.ts#L176">src/user/user-client.ts:176</a></li></ul></aside></div></li></ul></section>
252
+ <section class="tsd-panel tsd-member">
253
+ <h3 class="tsd-anchor-link" id="globalsignout"><span>global<wbr/>Sign<wbr/>Out</span><a href="#globalsignout" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
254
+ <ul class="tsd-signatures">
255
+ <li class="">
256
+ <div class="tsd-signature tsd-anchor-link" id="globalsignout-1"><span class="tsd-kind-call-signature">globalSignOut</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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
257
+ <div class="tsd-description">
258
+ <div class="tsd-comment tsd-typography"><p>Signs out the user from all devices.</p>
259
+ </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">
261
+ <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#globalsignout">globalSignOut</a></p>
262
+ <ul>
263
+ <li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/e9ea129dc5195b2e28a6cfc8cb56acd7a815b9e6/src/user/user-client.ts#L311">src/user/user-client.ts:311</a></li></ul></aside></div></li></ul></section>
264
+ <section class="tsd-panel tsd-member">
265
+ <h3 class="tsd-anchor-link" id="isregistered"><span>is<wbr/>Registered</span><a href="#isregistered" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
266
+ <ul class="tsd-signatures">
267
+ <li class="">
268
+ <div class="tsd-signature tsd-anchor-link" id="isregistered-1"><span class="tsd-kind-call-signature">isRegistered</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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
269
+ <div class="tsd-description">
270
+ <div class="tsd-comment tsd-typography"><p>Indicates whether or not this client is registered with Sudo Platform backend.</p>
271
+ </div>
272
+ <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>
273
+ <aside class="tsd-sources">
274
+ <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#isregistered">isRegistered</a></p>
275
+ <ul>
276
+ <li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/e9ea129dc5195b2e28a6cfc8cb56acd7a815b9e6/src/user/user-client.ts#L400">src/user/user-client.ts:400</a></li></ul></aside></div></li></ul></section>
277
+ <section class="tsd-panel tsd-member">
278
+ <h3 class="tsd-anchor-link" id="issignedin"><span>is<wbr/>Signed<wbr/>In</span><a href="#issignedin" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
279
+ <ul class="tsd-signatures">
280
+ <li class="">
281
+ <div class="tsd-signature tsd-anchor-link" id="issignedin-1"><span class="tsd-kind-call-signature">isSignedIn</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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
282
+ <div class="tsd-description">
283
+ <div class="tsd-comment tsd-typography"><p>Indicates whether or not this client is signed in with Sudo Platform backend. The client is
62
284
  considered signed in if it cached valid ID, access and refresh tokens.</p>
63
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4><p><em>true</em> if the client is signed in.</p>
64
- <aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#issignedin">isSignedIn</a></p><ul><li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/72cd12f9f9bec77ccf225c79dca7e850cb25ba57/src/user/user-client.ts#L199">src/user/user-client.ts:199</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="presentfederatedsigninui"><span>present<wbr/>Federated<wbr/>Sign<wbr/>In<wbr/>UI</span><a href="#presentfederatedsigninui" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="presentfederatedsigninui-1"><span class="tsd-kind-call-signature">presentFederatedSignInUI</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#presentfederatedsigninui-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Presents the sign in UI for federated sign in using an external identity provider.</p>
65
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#presentfederatedsigninui">presentFederatedSignInUI</a></p><ul><li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/72cd12f9f9bec77ccf225c79dca7e850cb25ba57/src/user/user-client.ts#L118">src/user/user-client.ts:118</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="presentsignoutui"><span>present<wbr/>Sign<wbr/>Out<wbr/>UI</span><a href="#presentsignoutui" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="presentsignoutui-1"><span class="tsd-kind-call-signature">presentSignOutUI</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#presentsignoutui-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Presents the Cognito hosted UI signout endpoint.
285
+ </div>
286
+ <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>
287
+ <aside class="tsd-sources">
288
+ <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#issignedin">isSignedIn</a></p>
289
+ <ul>
290
+ <li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/e9ea129dc5195b2e28a6cfc8cb56acd7a815b9e6/src/user/user-client.ts#L214">src/user/user-client.ts:214</a></li></ul></aside></div></li></ul></section>
291
+ <section class="tsd-panel tsd-member">
292
+ <h3 class="tsd-anchor-link" id="presentfederatedsigninui"><span>present<wbr/>Federated<wbr/>Sign<wbr/>In<wbr/>UI</span><a href="#presentfederatedsigninui" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
293
+ <ul class="tsd-signatures">
294
+ <li class="">
295
+ <div class="tsd-signature tsd-anchor-link" id="presentfederatedsigninui-1"><span class="tsd-kind-call-signature">presentFederatedSignInUI</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#presentfederatedsigninui-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
296
+ <div class="tsd-description">
297
+ <div class="tsd-comment tsd-typography"><p>Presents the sign in UI for federated sign in using an external identity provider.</p>
298
+ </div>
299
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
300
+ <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#presentfederatedsigninui">presentFederatedSignInUI</a></p>
301
+ <ul>
302
+ <li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/e9ea129dc5195b2e28a6cfc8cb56acd7a815b9e6/src/user/user-client.ts#L118">src/user/user-client.ts:118</a></li></ul></aside></div></li></ul></section>
303
+ <section class="tsd-panel tsd-member">
304
+ <h3 class="tsd-anchor-link" id="presentsignoutui"><span>present<wbr/>Sign<wbr/>Out<wbr/>UI</span><a href="#presentsignoutui" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
305
+ <ul class="tsd-signatures">
306
+ <li class="">
307
+ <div class="tsd-signature tsd-anchor-link" id="presentsignoutui-1"><span class="tsd-kind-call-signature">presentSignOutUI</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#presentsignoutui-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
308
+ <div class="tsd-description">
309
+ <div class="tsd-comment tsd-typography"><p>Presents the Cognito hosted UI signout endpoint.
66
310
  When the endpoint is invoked, the hosted web app's cookies
67
311
  will be invalidated, but the user is not logged out of Cognito.</p>
68
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#presentsignoutui">presentSignOutUI</a></p><ul><li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/72cd12f9f9bec77ccf225c79dca7e850cb25ba57/src/user/user-client.ts#L430">src/user/user-client.ts:430</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="processfederatedsignintokens"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="processfederatedsignintokens-1"><span class="tsd-kind-call-signature">processFederatedSignInTokens</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span><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 tsd-kind-interface">AuthenticationTokens</a><span class="tsd-signature-symbol">&gt;</span><a href="#processfederatedsignintokens-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Processes tokens from federated sign in returned to the specified URL.
312
+ </div>
313
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
314
+ <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#presentsignoutui">presentSignOutUI</a></p>
315
+ <ul>
316
+ <li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/e9ea129dc5195b2e28a6cfc8cb56acd7a815b9e6/src/user/user-client.ts#L447">src/user/user-client.ts:447</a></li></ul></aside></div></li></ul></section>
317
+ <section class="tsd-panel tsd-member">
318
+ <h3 class="tsd-anchor-link" id="processfederatedsignintokens"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
319
+ <ul class="tsd-signatures">
320
+ <li class="">
321
+ <div class="tsd-signature tsd-anchor-link" id="processfederatedsignintokens-1"><span class="tsd-kind-call-signature">processFederatedSignInTokens</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span><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 tsd-kind-interface">AuthenticationTokens</a><span class="tsd-signature-symbol">&gt;</span><a href="#processfederatedsignintokens-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
322
+ <div class="tsd-description">
323
+ <div class="tsd-comment tsd-typography"><p>Processes tokens from federated sign in returned to the specified URL.
69
324
  The tokens are passed to the web app via a redirect URL.</p>
70
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">url</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>callback URL containing the tokens.</p>
71
- </div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AuthenticationTokens.html" class="tsd-signature-type tsd-kind-interface">AuthenticationTokens</a><span class="tsd-signature-symbol">&gt;</span></h4><p>Successful authentication result AuthenticationTokens.</p>
72
- <aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#processfederatedsignintokens">processFederatedSignInTokens</a></p><ul><li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/72cd12f9f9bec77ccf225c79dca7e850cb25ba57/src/user/user-client.ts#L128">src/user/user-client.ts:128</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="refreshtokens"><span>refresh<wbr/>Tokens</span><a href="#refreshtokens" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="refreshtokens-1"><span class="tsd-kind-call-signature">refreshTokens</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">refreshToken</span><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 tsd-kind-interface">AuthenticationTokens</a><span class="tsd-signature-symbol">&gt;</span><a href="#refreshtokens-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Refresh the access and ID tokens using the refresh token.</p>
73
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">refreshToken</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>refresh token used to refresh the access and ID tokens.</p>
74
- </div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AuthenticationTokens.html" class="tsd-signature-type tsd-kind-interface">AuthenticationTokens</a><span class="tsd-signature-symbol">&gt;</span></h4><p>Successful authentication result AuthenticationTokens containing refreshed tokens</p>
75
- <aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#refreshtokens">refreshTokens</a></p><ul><li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/72cd12f9f9bec77ccf225c79dca7e850cb25ba57/src/user/user-client.ts#L223">src/user/user-client.ts:223</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="registerwithauthenticationprovider"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="registerwithauthenticationprovider-1"><span class="tsd-kind-call-signature">registerWithAuthenticationProvider</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">authenticationProvider</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/AuthenticationProvider.html" class="tsd-signature-type tsd-kind-interface">AuthenticationProvider</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">registrationId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/><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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Registers this client against the backend with an external authentication provider. The caller must
325
+ </div>
326
+ <div class="tsd-parameters">
327
+ <h4 class="tsd-parameters-title">Parameters</h4>
328
+ <ul class="tsd-parameter-list">
329
+ <li><span><span class="tsd-kind-parameter">url</span>: <span class="tsd-signature-type">string</span></span>
330
+ <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 tsd-kind-interface">AuthenticationTokens</a><span class="tsd-signature-symbol">&gt;</span></h4><p>Successful authentication result AuthenticationTokens.</p>
333
+ <aside class="tsd-sources">
334
+ <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#processfederatedsignintokens">processFederatedSignInTokens</a></p>
335
+ <ul>
336
+ <li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/e9ea129dc5195b2e28a6cfc8cb56acd7a815b9e6/src/user/user-client.ts#L128">src/user/user-client.ts:128</a></li></ul></aside></div></li></ul></section>
337
+ <section class="tsd-panel tsd-member">
338
+ <h3 class="tsd-anchor-link" id="refreshtokens"><span>refresh<wbr/>Tokens</span><a href="#refreshtokens" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
339
+ <ul class="tsd-signatures">
340
+ <li class="">
341
+ <div class="tsd-signature tsd-anchor-link" id="refreshtokens-1"><span class="tsd-kind-call-signature">refreshTokens</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">refreshToken</span><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 tsd-kind-interface">AuthenticationTokens</a><span class="tsd-signature-symbol">&gt;</span><a href="#refreshtokens-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
342
+ <div class="tsd-description">
343
+ <div class="tsd-comment tsd-typography"><p>Refresh the access and ID tokens using the refresh token.</p>
344
+ </div>
345
+ <div class="tsd-parameters">
346
+ <h4 class="tsd-parameters-title">Parameters</h4>
347
+ <ul class="tsd-parameter-list">
348
+ <li><span><span class="tsd-kind-parameter">refreshToken</span>: <span class="tsd-signature-type">string</span></span>
349
+ <div class="tsd-comment tsd-typography"><p>refresh token used to refresh the access and ID tokens.</p>
350
+ </div></li></ul></div>
351
+ <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>
352
+ <aside class="tsd-sources">
353
+ <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#refreshtokens">refreshTokens</a></p>
354
+ <ul>
355
+ <li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/e9ea129dc5195b2e28a6cfc8cb56acd7a815b9e6/src/user/user-client.ts#L238">src/user/user-client.ts:238</a></li></ul></aside></div></li></ul></section>
356
+ <section class="tsd-panel tsd-member">
357
+ <h3 class="tsd-anchor-link" id="registerwithauthenticationprovider"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
358
+ <ul class="tsd-signatures">
359
+ <li class="">
360
+ <div class="tsd-signature tsd-anchor-link" id="registerwithauthenticationprovider-1"><span class="tsd-kind-call-signature">registerWithAuthenticationProvider</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">authenticationProvider</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/AuthenticationProvider.html" class="tsd-signature-type tsd-kind-interface">AuthenticationProvider</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">registrationId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/><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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
361
+ <div class="tsd-description">
362
+ <div class="tsd-comment tsd-typography"><p>Registers this client against the backend with an external authentication provider. The caller must
76
363
  implement AuthenticationProvider protocol to return the appropriate authentication token required
77
364
  to authorize the registration request.</p>
78
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">authenticationProvider</span>: <a href="../interfaces/AuthenticationProvider.html" class="tsd-signature-type tsd-kind-interface">AuthenticationProvider</a></span><div class="tsd-comment tsd-typography"><p>authentication provider that provides the authentication token.</p>
79
- </div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">registrationId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>registration ID to uniquely identify this registration request.</p>
80
- </div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>user ID of the newly created user</p>
81
- <aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#registerwithauthenticationprovider">registerWithAuthenticationProvider</a></p><ul><li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/72cd12f9f9bec77ccf225c79dca7e850cb25ba57/src/user/user-client.ts#L302">src/user/user-client.ts:302</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="reset"><span>reset</span><a href="#reset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="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-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#reset-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Resets internal state and clears any cached data.</p>
82
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#reset">reset</a></p><ul><li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/72cd12f9f9bec77ccf225c79dca7e850cb25ba57/src/user/user-client.ts#L434">src/user/user-client.ts:434</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="resetuserdata"><span>reset<wbr/>User<wbr/>Data</span><a href="#resetuserdata" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="resetuserdata-1"><span class="tsd-kind-call-signature">resetUserData</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#resetuserdata-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Removes all data owned by the signed-in user in Sudo Platform Services
365
+ </div>
366
+ <div class="tsd-parameters">
367
+ <h4 class="tsd-parameters-title">Parameters</h4>
368
+ <ul class="tsd-parameter-list">
369
+ <li><span><span class="tsd-kind-parameter">authenticationProvider</span>: <a href="../interfaces/AuthenticationProvider.html" class="tsd-signature-type tsd-kind-interface">AuthenticationProvider</a></span>
370
+ <div class="tsd-comment tsd-typography"><p>authentication provider that provides the authentication token.</p>
371
+ </div></li>
372
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">registrationId</span>: <span class="tsd-signature-type">string</span></span>
373
+ <div class="tsd-comment tsd-typography"><p>registration ID to uniquely identify this registration request.</p>
374
+ </div></li></ul></div>
375
+ <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>
376
+ <aside class="tsd-sources">
377
+ <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#registerwithauthenticationprovider">registerWithAuthenticationProvider</a></p>
378
+ <ul>
379
+ <li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/e9ea129dc5195b2e28a6cfc8cb56acd7a815b9e6/src/user/user-client.ts#L319">src/user/user-client.ts:319</a></li></ul></aside></div></li></ul></section>
380
+ <section class="tsd-panel tsd-member">
381
+ <h3 class="tsd-anchor-link" id="reset"><span>reset</span><a href="#reset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
382
+ <ul class="tsd-signatures">
383
+ <li class="">
384
+ <div class="tsd-signature tsd-anchor-link" id="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-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#reset-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
385
+ <div class="tsd-description">
386
+ <div class="tsd-comment tsd-typography"><p>Resets internal state and clears any cached data.</p>
387
+ </div>
388
+ <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">
389
+ <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#reset">reset</a></p>
390
+ <ul>
391
+ <li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/e9ea129dc5195b2e28a6cfc8cb56acd7a815b9e6/src/user/user-client.ts#L451">src/user/user-client.ts:451</a></li></ul></aside></div></li></ul></section>
392
+ <section class="tsd-panel tsd-member">
393
+ <h3 class="tsd-anchor-link" id="resetuserdata"><span>reset<wbr/>User<wbr/>Data</span><a href="#resetuserdata" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
394
+ <ul class="tsd-signatures">
395
+ <li class="">
396
+ <div class="tsd-signature tsd-anchor-link" id="resetuserdata-1"><span class="tsd-kind-call-signature">resetUserData</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#resetuserdata-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
397
+ <div class="tsd-description">
398
+ <div class="tsd-comment tsd-typography"><p>Removes all data owned by the signed-in user in Sudo Platform Services
83
399
  without deregistering the user.
84
400
  Should only be used in tests.</p>
85
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#resetuserdata">resetUserData</a></p><ul><li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/72cd12f9f9bec77ccf225c79dca7e850cb25ba57/src/user/user-client.ts#L440">src/user/user-client.ts:440</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="setauthenticationstore"><span>set<wbr/>Authentication<wbr/>Store</span><a href="#setauthenticationstore" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="setauthenticationstore-1"><span class="tsd-kind-call-signature">setAuthenticationStore</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">authenticationStore</span><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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Provide a custom authentication store.
401
+ </div>
402
+ <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">
403
+ <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#resetuserdata">resetUserData</a></p>
404
+ <ul>
405
+ <li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/e9ea129dc5195b2e28a6cfc8cb56acd7a815b9e6/src/user/user-client.ts#L457">src/user/user-client.ts:457</a></li></ul></aside></div></li></ul></section>
406
+ <section class="tsd-panel tsd-member">
407
+ <h3 class="tsd-anchor-link" id="setauthenticationstore"><span>set<wbr/>Authentication<wbr/>Store</span><a href="#setauthenticationstore" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
408
+ <ul class="tsd-signatures">
409
+ <li class="">
410
+ <div class="tsd-signature tsd-anchor-link" id="setauthenticationstore-1"><span class="tsd-kind-call-signature">setAuthenticationStore</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">authenticationStore</span><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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
411
+ <div class="tsd-description">
412
+ <div class="tsd-comment tsd-typography"><p>Provide a custom authentication store.
86
413
  This is mainly used for unit testing (optional).</p>
87
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">authenticationStore</span>: <span class="tsd-signature-type">AuthenticationStore</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/72cd12f9f9bec77ccf225c79dca7e850cb25ba57/src/user/user-client.ts#L564">src/user/user-client.ts:564</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="setauthui"><span>set<wbr/>Auth<wbr/>UI</span><a href="#setauthui" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="setauthui-1"><span class="tsd-kind-call-signature">setAuthUI</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">authUI</span><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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Provide a custom auth UI. This is mainly used for unit testing (optional).</p>
88
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">authUI</span>: <span class="tsd-signature-type">AuthUI</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/72cd12f9f9bec77ccf225c79dca7e850cb25ba57/src/user/user-client.ts#L541">src/user/user-client.ts:541</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="setidentityprovider"><span>set<wbr/>Identity<wbr/>Provider</span><a href="#setidentityprovider" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="setidentityprovider-1"><span class="tsd-kind-call-signature">setIdentityProvider</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">identityProvider</span><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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Provide a custom identity provider. This is mainly used for unit testing (optional).</p>
89
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">identityProvider</span>: <span class="tsd-signature-type">IdentityProvider</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/72cd12f9f9bec77ccf225c79dca7e850cb25ba57/src/user/user-client.ts#L548">src/user/user-client.ts:548</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="setlaunchurifn"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="setlaunchurifn-1"><span class="tsd-kind-call-signature">setLaunchUriFn</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-kind-parameter">url</span><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-type">void</span><a href="#setlaunchurifn-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Provide a custom function to open the sign in url.
414
+ </div>
415
+ <div class="tsd-parameters">
416
+ <h4 class="tsd-parameters-title">Parameters</h4>
417
+ <ul class="tsd-parameter-list">
418
+ <li><span><span class="tsd-kind-parameter">authenticationStore</span>: <span class="tsd-signature-type">AuthenticationStore</span></span></li></ul></div>
419
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
420
+ <ul>
421
+ <li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/e9ea129dc5195b2e28a6cfc8cb56acd7a815b9e6/src/user/user-client.ts#L588">src/user/user-client.ts:588</a></li></ul></aside></div></li></ul></section>
422
+ <section class="tsd-panel tsd-member">
423
+ <h3 class="tsd-anchor-link" id="setauthui"><span>set<wbr/>Auth<wbr/>UI</span><a href="#setauthui" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
424
+ <ul class="tsd-signatures">
425
+ <li class="">
426
+ <div class="tsd-signature tsd-anchor-link" id="setauthui-1"><span class="tsd-kind-call-signature">setAuthUI</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">authUI</span><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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
427
+ <div class="tsd-description">
428
+ <div class="tsd-comment tsd-typography"><p>Provide a custom auth UI. This is mainly used for unit testing (optional).</p>
429
+ </div>
430
+ <div class="tsd-parameters">
431
+ <h4 class="tsd-parameters-title">Parameters</h4>
432
+ <ul class="tsd-parameter-list">
433
+ <li><span><span class="tsd-kind-parameter">authUI</span>: <span class="tsd-signature-type">AuthUI</span></span></li></ul></div>
434
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
435
+ <ul>
436
+ <li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/e9ea129dc5195b2e28a6cfc8cb56acd7a815b9e6/src/user/user-client.ts#L565">src/user/user-client.ts:565</a></li></ul></aside></div></li></ul></section>
437
+ <section class="tsd-panel tsd-member">
438
+ <h3 class="tsd-anchor-link" id="setidentityprovider"><span>set<wbr/>Identity<wbr/>Provider</span><a href="#setidentityprovider" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
439
+ <ul class="tsd-signatures">
440
+ <li class="">
441
+ <div class="tsd-signature tsd-anchor-link" id="setidentityprovider-1"><span class="tsd-kind-call-signature">setIdentityProvider</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">identityProvider</span><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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
442
+ <div class="tsd-description">
443
+ <div class="tsd-comment tsd-typography"><p>Provide a custom identity provider. This is mainly used for unit testing (optional).</p>
444
+ </div>
445
+ <div class="tsd-parameters">
446
+ <h4 class="tsd-parameters-title">Parameters</h4>
447
+ <ul class="tsd-parameter-list">
448
+ <li><span><span class="tsd-kind-parameter">identityProvider</span>: <span class="tsd-signature-type">IdentityProvider</span></span></li></ul></div>
449
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
450
+ <ul>
451
+ <li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/e9ea129dc5195b2e28a6cfc8cb56acd7a815b9e6/src/user/user-client.ts#L572">src/user/user-client.ts:572</a></li></ul></aside></div></li></ul></section>
452
+ <section class="tsd-panel tsd-member">
453
+ <h3 class="tsd-anchor-link" id="setlaunchurifn"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
454
+ <ul class="tsd-signatures">
455
+ <li class="">
456
+ <div class="tsd-signature tsd-anchor-link" id="setlaunchurifn-1"><span class="tsd-kind-call-signature">setLaunchUriFn</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-kind-parameter">url</span><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-type">void</span><a href="#setlaunchurifn-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
457
+ <div class="tsd-description">
458
+ <div class="tsd-comment tsd-typography"><p>Provide a custom function to open the sign in url.
90
459
  This is mainly used for unit testing (optional).</p>
91
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">launchUriFn</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span><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></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/72cd12f9f9bec77ccf225c79dca7e850cb25ba57/src/user/user-client.ts#L556">src/user/user-client.ts:556</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="setusername"><span>set<wbr/>User<wbr/>Name</span><a href="#setusername" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="setusername-1"><span class="tsd-kind-call-signature">setUserName</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the user name associated with this client.</p>
92
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>user name.</p>
93
- </div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#setusername">setUserName</a></p><ul><li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/72cd12f9f9bec77ccf225c79dca7e850cb25ba57/src/user/user-client.ts#L184">src/user/user-client.ts:184</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="signinwithauthenticationprovider"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="signinwithauthenticationprovider-1"><span class="tsd-kind-call-signature">signInWithAuthenticationProvider</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">authenticationProvider</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/AuthenticationProvider.html" class="tsd-signature-type tsd-kind-interface">AuthenticationProvider</a><span class="tsd-signature-symbol">,</span><br/><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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sign into the backend using an external authentication provider. Caller must implement
460
+ </div>
461
+ <div class="tsd-parameters">
462
+ <h4 class="tsd-parameters-title">Parameters</h4>
463
+ <ul class="tsd-parameter-list">
464
+ <li><span><span class="tsd-kind-parameter">launchUriFn</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span><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></li></ul></div>
465
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
466
+ <ul>
467
+ <li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/e9ea129dc5195b2e28a6cfc8cb56acd7a815b9e6/src/user/user-client.ts#L580">src/user/user-client.ts:580</a></li></ul></aside></div></li></ul></section>
468
+ <section class="tsd-panel tsd-member">
469
+ <h3 class="tsd-anchor-link" id="setusername"><span>set<wbr/>User<wbr/>Name</span><a href="#setusername" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
470
+ <ul class="tsd-signatures">
471
+ <li class="">
472
+ <div class="tsd-signature tsd-anchor-link" id="setusername-1"><span class="tsd-kind-call-signature">setUserName</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
473
+ <div class="tsd-description">
474
+ <div class="tsd-comment tsd-typography"><p>Sets the user name associated with this client.</p>
475
+ </div>
476
+ <div class="tsd-parameters">
477
+ <h4 class="tsd-parameters-title">Parameters</h4>
478
+ <ul class="tsd-parameter-list">
479
+ <li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span>
480
+ <div class="tsd-comment tsd-typography"><p>user name.</p>
481
+ </div></li></ul></div>
482
+ <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">
483
+ <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#setusername">setUserName</a></p>
484
+ <ul>
485
+ <li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/e9ea129dc5195b2e28a6cfc8cb56acd7a815b9e6/src/user/user-client.ts#L184">src/user/user-client.ts:184</a></li></ul></aside></div></li></ul></section>
486
+ <section class="tsd-panel tsd-member">
487
+ <h3 class="tsd-anchor-link" id="signinviaassumption"><span>sign<wbr/>In<wbr/>Via<wbr/>Assumption</span><a href="#signinviaassumption" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
488
+ <ul class="tsd-signatures">
489
+ <li class="">
490
+ <div class="tsd-signature tsd-anchor-link" id="signinviaassumption-1"><span class="tsd-kind-call-signature">signInViaAssumption</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">username</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">idToken</span><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="#signinviaassumption-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
491
+ <div class="tsd-description">
492
+ <div class="tsd-comment tsd-typography"><p>Signs in as the specified user by assuming an ID token obtained
493
+ externally, e.g. from another Sudo Platform client acting on this
494
+ user's behalf. Unlike the other sign in methods, no access or refresh
495
+ token is cached, so the assumed ID token cannot be refreshed once it
496
+ expires and <em>isSignedIn</em> will return <em>false</em>.</p>
497
+ </div>
498
+ <div class="tsd-parameters">
499
+ <h4 class="tsd-parameters-title">Parameters</h4>
500
+ <ul class="tsd-parameter-list">
501
+ <li><span><span class="tsd-kind-parameter">username</span>: <span class="tsd-signature-type">string</span></span>
502
+ <div class="tsd-comment tsd-typography"><p>user name of the user being signed in as.</p>
503
+ </div></li>
504
+ <li><span><span class="tsd-kind-parameter">idToken</span>: <span class="tsd-signature-type">string</span></span>
505
+ <div class="tsd-comment tsd-typography"><p>ID token to assume.</p>
506
+ </div></li></ul></div>
507
+ <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>
508
+ <div class="tsd-comment tsd-typography">
509
+ <div class="tsd-tag-throws">
510
+ <h4 class="tsd-anchor-link" id="throws">Throws<a href="#throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="AlreadySignedInError.html" class="tsd-kind-class">AlreadySignedInError</a> if the client is already signed in.</p>
511
+ </div></div><aside class="tsd-sources">
512
+ <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#signinviaassumption">signInViaAssumption</a></p>
513
+ <ul>
514
+ <li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/e9ea129dc5195b2e28a6cfc8cb56acd7a815b9e6/src/user/user-client.ts#L189">src/user/user-client.ts:189</a></li></ul></aside></div></li></ul></section>
515
+ <section class="tsd-panel tsd-member">
516
+ <h3 class="tsd-anchor-link" id="signinwithauthenticationprovider"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
517
+ <ul class="tsd-signatures">
518
+ <li class="">
519
+ <div class="tsd-signature tsd-anchor-link" id="signinwithauthenticationprovider-1"><span class="tsd-kind-call-signature">signInWithAuthenticationProvider</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">authenticationProvider</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/AuthenticationProvider.html" class="tsd-signature-type tsd-kind-interface">AuthenticationProvider</a><span class="tsd-signature-symbol">,</span><br/><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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
520
+ <div class="tsd-description">
521
+ <div class="tsd-comment tsd-typography"><p>Sign into the backend using an external authentication provider. Caller must implement
94
522
  <em>AuthenticationProvider</em> interface to return the appropriate authentication token associated with
95
523
  the external identity registered with <em>registerWithAuthenticationProvider</em>.</p>
96
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">authenticationProvider</span>: <a href="../interfaces/AuthenticationProvider.html" class="tsd-signature-type tsd-kind-interface">AuthenticationProvider</a></span><div class="tsd-comment tsd-typography"><p>authentication provider that provides the authentication token.</p>
97
- </div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AuthenticationTokens.html" class="tsd-signature-type tsd-kind-interface">AuthenticationTokens</a><span class="tsd-signature-symbol">&gt;</span></h4><p>authentication tokens associated with the successful sign in.</p>
98
- <aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#signinwithauthenticationprovider">signInWithAuthenticationProvider</a></p><ul><li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/72cd12f9f9bec77ccf225c79dca7e850cb25ba57/src/user/user-client.ts#L357">src/user/user-client.ts:357</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="signinwithkey"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="signinwithkey-1"><span class="tsd-kind-call-signature">signInWithKey</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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sign into the backend using a private key. The client must have created a private/public key pair via
524
+ </div>
525
+ <div class="tsd-parameters">
526
+ <h4 class="tsd-parameters-title">Parameters</h4>
527
+ <ul class="tsd-parameter-list">
528
+ <li><span><span class="tsd-kind-parameter">authenticationProvider</span>: <a href="../interfaces/AuthenticationProvider.html" class="tsd-signature-type tsd-kind-interface">AuthenticationProvider</a></span>
529
+ <div class="tsd-comment tsd-typography"><p>authentication provider that provides the authentication token.</p>
530
+ </div></li></ul></div>
531
+ <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>
532
+ <aside class="tsd-sources">
533
+ <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#signinwithauthenticationprovider">signInWithAuthenticationProvider</a></p>
534
+ <ul>
535
+ <li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/e9ea129dc5195b2e28a6cfc8cb56acd7a815b9e6/src/user/user-client.ts#L374">src/user/user-client.ts:374</a></li></ul></aside></div></li></ul></section>
536
+ <section class="tsd-panel tsd-member">
537
+ <h3 class="tsd-anchor-link" id="signinwithkey"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
538
+ <ul class="tsd-signatures">
539
+ <li class="">
540
+ <div class="tsd-signature tsd-anchor-link" id="signinwithkey-1"><span class="tsd-kind-call-signature">signInWithKey</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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
541
+ <div class="tsd-description">
542
+ <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
99
543
  the <em>registerWithAuthenticationProvider</em> method.</p>
100
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AuthenticationTokens.html" class="tsd-signature-type tsd-kind-interface">AuthenticationTokens</a><span class="tsd-signature-symbol">&gt;</span></h4><p>authentication tokens associated with the successful sign in.</p>
101
- <aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#signinwithkey">signInWithKey</a></p><ul><li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/72cd12f9f9bec77ccf225c79dca7e850cb25ba57/src/user/user-client.ts#L392">src/user/user-client.ts:392</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="signout"><span>sign<wbr/>Out</span><a href="#signout" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="signout-1"><span class="tsd-kind-call-signature">signOut</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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Signs out the user from this device.</p>
102
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#signout">signOut</a></p><ul><li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/72cd12f9f9bec77ccf225c79dca7e850cb25ba57/src/user/user-client.ts#L276">src/user/user-client.ts:276</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary><div><a href="#sudokeymanager"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>sudo<wbr/>Key<wbr/>Manager</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#clearauthenticationtokens"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clear<wbr/>Authentication<wbr/>Tokens</span></a><a href="#deregister"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>deregister</span></a><a href="#getaccesstoken"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Access<wbr/>Token</span></a><a href="#getidtoken"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Id<wbr/>Token</span></a><a href="#getlatestauthtoken"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Latest<wbr/>Auth<wbr/>Token</span></a><a href="#getrefreshtoken"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Refresh<wbr/>Token</span></a><a href="#getrefreshtokenexpiry"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Refresh<wbr/>Token<wbr/>Expiry</span></a><a href="#getsubject"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Subject</span></a><a href="#gettokenexpiry"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Token<wbr/>Expiry</span></a><a href="#getuserclaim"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>User<wbr/>Claim</span></a><a href="#getusername"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>User<wbr/>Name</span></a><a href="#globalsignout"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>global<wbr/>Sign<wbr/>Out</span></a><a href="#isregistered"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Registered</span></a><a href="#issignedin"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Signed<wbr/>In</span></a><a href="#presentfederatedsigninui"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>present<wbr/>Federated<wbr/>Sign<wbr/>In<wbr/>UI</span></a><a href="#presentsignoutui"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>present<wbr/>Sign<wbr/>Out<wbr/>UI</span></a><a href="#processfederatedsignintokens"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>process<wbr/>Federated<wbr/>Sign<wbr/>In<wbr/>Tokens</span></a><a href="#refreshtokens"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>refresh<wbr/>Tokens</span></a><a href="#registerwithauthenticationprovider"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>register<wbr/>With<wbr/>Authentication<wbr/>Provider</span></a><a href="#reset"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reset</span></a><a href="#resetuserdata"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reset<wbr/>User<wbr/>Data</span></a><a href="#setauthenticationstore"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Authentication<wbr/>Store</span></a><a href="#setauthui"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Auth<wbr/>UI</span></a><a href="#setidentityprovider"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Identity<wbr/>Provider</span></a><a href="#setlaunchurifn"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Launch<wbr/>Uri<wbr/>Fn</span></a><a href="#setusername"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>User<wbr/>Name</span></a><a href="#signinwithauthenticationprovider"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sign<wbr/>In<wbr/>With<wbr/>Authentication<wbr/>Provider</span></a><a href="#signinwithkey"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sign<wbr/>In<wbr/>With<wbr/>Key</span></a><a href="#signout"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sign<wbr/>Out</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@sudoplatform/sudo-user</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
544
+ </div>
545
+ <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>
546
+ <aside class="tsd-sources">
547
+ <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#signinwithkey">signInWithKey</a></p>
548
+ <ul>
549
+ <li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/e9ea129dc5195b2e28a6cfc8cb56acd7a815b9e6/src/user/user-client.ts#L409">src/user/user-client.ts:409</a></li></ul></aside></div></li></ul></section>
550
+ <section class="tsd-panel tsd-member">
551
+ <h3 class="tsd-anchor-link" id="signout"><span>sign<wbr/>Out</span><a href="#signout" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
552
+ <ul class="tsd-signatures">
553
+ <li class="">
554
+ <div class="tsd-signature tsd-anchor-link" id="signout-1"><span class="tsd-kind-call-signature">signOut</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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
555
+ <div class="tsd-description">
556
+ <div class="tsd-comment tsd-typography"><p>Signs out the user from this device.</p>
557
+ </div>
558
+ <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">
559
+ <p>Implementation of <a href="../interfaces/SudoUserClient.html">SudoUserClient</a>.<a href="../interfaces/SudoUserClient.html#signout">signOut</a></p>
560
+ <ul>
561
+ <li>Defined in <a href="https://github.com/sudoplatform/sudo-user-js/blob/e9ea129dc5195b2e28a6cfc8cb56acd7a815b9e6/src/user/user-client.ts#L293">src/user/user-client.ts:293</a></li></ul></aside></div></li></ul></section></section></details></div>
562
+ <div class="col-sidebar">
563
+ <div class="page-menu">
564
+ <div class="tsd-navigation settings">
565
+ <details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
566
+ <h3>Settings</h3></summary>
567
+ <div class="tsd-accordion-details">
568
+ <div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
569
+ <ul id="tsd-filter-options">
570
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
571
+ <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>
572
+ <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></div>
573
+ <div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
574
+ <details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
575
+ <h3>On This Page</h3></summary>
576
+ <div class="tsd-accordion-details">
577
+ <details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary>
578
+ <div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details>
579
+ <details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary>
580
+ <div><a href="#sudokeymanager"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>sudo<wbr/>Key<wbr/>Manager</span></a></div></details>
581
+ <details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary>
582
+ <div><a href="#clearauthenticationtokens"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clear<wbr/>Authentication<wbr/>Tokens</span></a><a href="#deregister"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>deregister</span></a><a href="#getaccesstoken"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Access<wbr/>Token</span></a><a href="#getidtoken"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Id<wbr/>Token</span></a><a href="#getlatestauthtoken"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Latest<wbr/>Auth<wbr/>Token</span></a><a href="#getrefreshtoken"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Refresh<wbr/>Token</span></a><a href="#getrefreshtokenexpiry"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Refresh<wbr/>Token<wbr/>Expiry</span></a><a href="#getsubject"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Subject</span></a><a href="#gettokenexpiry"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Token<wbr/>Expiry</span></a><a href="#getuserclaim"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>User<wbr/>Claim</span></a><a href="#getusername"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>User<wbr/>Name</span></a><a href="#globalsignout"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>global<wbr/>Sign<wbr/>Out</span></a><a href="#isregistered"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Registered</span></a><a href="#issignedin"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Signed<wbr/>In</span></a><a href="#presentfederatedsigninui"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>present<wbr/>Federated<wbr/>Sign<wbr/>In<wbr/>UI</span></a><a href="#presentsignoutui"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>present<wbr/>Sign<wbr/>Out<wbr/>UI</span></a><a href="#processfederatedsignintokens"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>process<wbr/>Federated<wbr/>Sign<wbr/>In<wbr/>Tokens</span></a><a href="#refreshtokens"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>refresh<wbr/>Tokens</span></a><a href="#registerwithauthenticationprovider"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>register<wbr/>With<wbr/>Authentication<wbr/>Provider</span></a><a href="#reset"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reset</span></a><a href="#resetuserdata"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reset<wbr/>User<wbr/>Data</span></a><a href="#setauthenticationstore"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Authentication<wbr/>Store</span></a><a href="#setauthui"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Auth<wbr/>UI</span></a><a href="#setidentityprovider"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Identity<wbr/>Provider</span></a><a href="#setlaunchurifn"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Launch<wbr/>Uri<wbr/>Fn</span></a><a href="#setusername"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>User<wbr/>Name</span></a><a href="#signinviaassumption"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sign<wbr/>In<wbr/>Via<wbr/>Assumption</span></a><a href="#signinwithauthenticationprovider"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sign<wbr/>In<wbr/>With<wbr/>Authentication<wbr/>Provider</span></a><a href="#signinwithkey"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sign<wbr/>In<wbr/>With<wbr/>Key</span></a><a href="#signout"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sign<wbr/>Out</span></a></div></details></div></details></div>
583
+ <div class="site-menu">
584
+ <nav class="tsd-navigation"><a href="../modules.html">@sudoplatform/sudo-user</a>
585
+ <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
586
+ <li>Loading...</li></ul></nav></div></div></div><footer>
587
+ <p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
588
+ <div class="overlay"></div></body></html>