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