@sudoplatform/sudo-user 13.0.0 → 13.0.2

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