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