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