-
Notifications
You must be signed in to change notification settings - Fork 314
Expand file tree
/
Copy pathauth.OAuth.html
More file actions
81 lines (74 loc) · 65.4 KB
/
Copy pathauth.OAuth.html
File metadata and controls
81 lines (74 loc) · 65.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>OAuth | Auth0 Node.js SDK - v5.10.0</title><meta name="description" content="Documentation for Auth0 Node.js SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Auth0 Node.js SDK - v5.10.0</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/auth.html">auth</a></li><li><a href="" aria-current="page">OAuth</a></li></ul><h1>Class OAuth</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>OAuth 2.0 flows.</p>
</div></section><section class="tsd-panel tsd-hierarchy" data-refl="262"><h4>Hierarchy (<a href="../hierarchy.html#auth.OAuth">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="auth.SDK.BaseAuthAPI.html" class="tsd-signature-type tsd-kind-class">BaseAuthAPI</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">OAuth</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#authorizationcodegrant" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>authorization<wbr/>Code<wbr/>Grant</span></a>
<a href="#authorizationcodegrantwithpkce" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>authorization<wbr/>Code<wbr/>Grant<wbr/>With<wbr/>PKCE</span></a>
<a href="#clientcredentialsgrant" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>client<wbr/>Credentials<wbr/>Grant</span></a>
<a href="#pushedauthorization" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pushed<wbr/>Authorization</span></a>
<a href="#passwordgrant" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>password<wbr/>Grant</span></a>
<a href="#refreshtokengrant" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>refresh<wbr/>Token<wbr/>Grant</span></a>
<a href="#revokerefreshtoken" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>revoke<wbr/>Refresh<wbr/>Token</span></a>
<a href="#tokenforconnection" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>token<wbr/>For<wbr/>Connection</span></a>
<a href="#request" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>request</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#domain" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>domain</span></a>
<a href="#clientid" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>client<wbr/>Id</span></a>
<a href="#clientsecret" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>client<wbr/>Secret?</span></a>
<a href="#clientassertionsigningkey" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>client<wbr/>Assertion<wbr/>Signing<wbr/>Key?</span></a>
<a href="#clientassertionsigningalg" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>client<wbr/>Assertion<wbr/>Signing<wbr/>Alg?</span></a>
<a href="#usemtls" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>use<wbr/>MTLS?</span></a>
<a href="#idtokenvalidator" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id<wbr/>Token<wbr/>Validator</span></a>
<a href="#configuration" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>configuration</span></a>
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructoroauth"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">OAuth</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/auth.AuthenticationClientOptions.html" class="tsd-signature-type tsd-kind-interface">AuthenticationClientOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">OAuth</a><a href="#constructoroauth" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/auth.AuthenticationClientOptions.html" class="tsd-signature-type tsd-kind-interface">AuthenticationClientOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">OAuth</a></h4><aside class="tsd-sources"><p>Overrides <a href="auth.SDK.BaseAuthAPI.html">BaseAuthAPI</a>.<a href="auth.SDK.BaseAuthAPI.html#constructor">constructor</a></p></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="authorizationcodegrant"><span>authorization<wbr/>Code<wbr/>Grant</span><a href="#authorizationcodegrant" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="authorizationcodegrant-1"><span class="tsd-kind-call-signature">authorizationCodeGrant</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">bodyParameters</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/auth.AuthorizationCodeGrantRequest.html" class="tsd-signature-type tsd-kind-interface">AuthorizationCodeGrantRequest</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/auth.AuthorizationCodeGrantOptions.html" class="tsd-signature-type tsd-kind-interface">AuthorizationCodeGrantOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="lib.JSONApiResponse.html" class="tsd-signature-type tsd-kind-class">JSONApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/auth.TokenSet.html" class="tsd-signature-type tsd-kind-interface">TokenSet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#authorizationcodegrant-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>This is the flow that regular web apps use to access an API.</p>
<p>Use this endpoint to exchange an Authorization Code for a Token.</p>
<p>See: <a href="https://auth0.com/docs/api/authentication#authorization-code-flow44">https://auth0.com/docs/api/authentication#authorization-code-flow44</a></p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">bodyParameters</span>: <a href="../interfaces/auth.AuthorizationCodeGrantRequest.html" class="tsd-signature-type tsd-kind-interface">AuthorizationCodeGrantRequest</a></span></li><li><span><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/auth.AuthorizationCodeGrantOptions.html" class="tsd-signature-type tsd-kind-interface">AuthorizationCodeGrantOptions</a><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="lib.JSONApiResponse.html" class="tsd-signature-type tsd-kind-class">JSONApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/auth.TokenSet.html" class="tsd-signature-type tsd-kind-interface">TokenSet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="js"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">auth0</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">AuthenticationApi</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">domain:</span><span class="hl-1"> </span><span class="hl-2">'my-domain.auth0.com'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">clientId:</span><span class="hl-1"> </span><span class="hl-2">'myClientId'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">clientSecret:</span><span class="hl-1"> </span><span class="hl-2">'myClientSecret'</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">auth0</span><span class="hl-1">.</span><span class="hl-4">oauth</span><span class="hl-1">.</span><span class="hl-0">authorizationCodeGrant</span><span class="hl-1">({ </span><span class="hl-4">code:</span><span class="hl-1"> </span><span class="hl-2">'mycode'</span><span class="hl-1"> });</span>
</code><button type="button">Copy</button></pre>
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="authorizationcodegrantwithpkce"><span>authorization<wbr/>Code<wbr/>Grant<wbr/>With<wbr/>PKCE</span><a href="#authorizationcodegrantwithpkce" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="authorizationcodegrantwithpkce-1"><span class="tsd-kind-call-signature">authorizationCodeGrantWithPKCE</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">bodyParameters</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/auth.AuthorizationCodeGrantWithPKCERequest.html" class="tsd-signature-type tsd-kind-interface">AuthorizationCodeGrantWithPKCERequest</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/auth.AuthorizationCodeGrantOptions.html" class="tsd-signature-type tsd-kind-interface">AuthorizationCodeGrantOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="lib.JSONApiResponse.html" class="tsd-signature-type tsd-kind-class">JSONApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/auth.TokenSet.html" class="tsd-signature-type tsd-kind-interface">TokenSet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#authorizationcodegrantwithpkce-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>PKCE was originally designed to protect the authorization code flow in mobile apps,
but its ability to prevent authorization code injection makes it useful for every type of OAuth client,
even web apps that use client authentication.</p>
<p>See: <a href="https://auth0.com/docs/api/authentication#authorization-code-flow-with-pkce45">https://auth0.com/docs/api/authentication#authorization-code-flow-with-pkce45</a></p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">bodyParameters</span>: <a href="../interfaces/auth.AuthorizationCodeGrantWithPKCERequest.html" class="tsd-signature-type tsd-kind-interface">AuthorizationCodeGrantWithPKCERequest</a></span></li><li><span><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/auth.AuthorizationCodeGrantOptions.html" class="tsd-signature-type tsd-kind-interface">AuthorizationCodeGrantOptions</a><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="lib.JSONApiResponse.html" class="tsd-signature-type tsd-kind-class">JSONApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/auth.TokenSet.html" class="tsd-signature-type tsd-kind-interface">TokenSet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-1">Example<a href="#example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="js"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">auth0</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">AuthenticationApi</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">domain:</span><span class="hl-1"> </span><span class="hl-2">'my-domain.auth0.com'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">clientId:</span><span class="hl-1"> </span><span class="hl-2">'myClientId'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">clientSecret:</span><span class="hl-1"> </span><span class="hl-2">'myClientSecret'</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">auth0</span><span class="hl-1">.</span><span class="hl-4">oauth</span><span class="hl-1">.</span><span class="hl-0">authorizationCodeGrantWithPKCE</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">code:</span><span class="hl-1"> </span><span class="hl-2">'mycode'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">code_verifier:</span><span class="hl-1"> </span><span class="hl-2">'mycodeverifier'</span><br/><span class="hl-1">});</span>
</code><button type="button">Copy</button></pre>
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="clientcredentialsgrant"><span>client<wbr/>Credentials<wbr/>Grant</span><a href="#clientcredentialsgrant" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="clientcredentialsgrant-1"><span class="tsd-kind-call-signature">clientCredentialsGrant</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">bodyParameters</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/auth.ClientCredentialsGrantRequest.html" class="tsd-signature-type tsd-kind-interface">ClientCredentialsGrantRequest</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">initOverrides</span><span class="tsd-signature-symbol">?:</span> <a href="../types/lib.InitOverride.html" class="tsd-signature-type tsd-kind-type-alias">InitOverride</a> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="lib.JSONApiResponse.html" class="tsd-signature-type tsd-kind-class">JSONApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/auth.TokenSet.html" class="tsd-signature-type tsd-kind-interface">TokenSet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#clientcredentialsgrant-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>This is the OAuth 2.0 grant that server processes use to access an API.</p>
<p>Use this endpoint to directly request an Access Token by using the Client's credentials
(a Client ID and a Client Secret or a Client Assertion).</p>
<p>See: <a href="https://auth0.com/docs/api/authentication#client-credentials-flow">https://auth0.com/docs/api/authentication#client-credentials-flow</a></p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">bodyParameters</span>: <a href="../interfaces/auth.ClientCredentialsGrantRequest.html" class="tsd-signature-type tsd-kind-interface">ClientCredentialsGrantRequest</a></span></li><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">initOverrides</span><span class="tsd-signature-symbol">?:</span> <a href="../types/lib.InitOverride.html" class="tsd-signature-type tsd-kind-type-alias">InitOverride</a> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="lib.JSONApiResponse.html" class="tsd-signature-type tsd-kind-class">JSONApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/auth.TokenSet.html" class="tsd-signature-type tsd-kind-interface">TokenSet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-2">Example<a href="#example-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="js"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">auth0</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">AuthenticationApi</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">domain:</span><span class="hl-1"> </span><span class="hl-2">'my-domain.auth0.com'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">clientId:</span><span class="hl-1"> </span><span class="hl-2">'myClientId'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">clientSecret:</span><span class="hl-1"> </span><span class="hl-2">'myClientSecret'</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">auth0</span><span class="hl-1">.</span><span class="hl-4">oauth</span><span class="hl-1">.</span><span class="hl-0">clientCredentialsGrant</span><span class="hl-1">({ </span><span class="hl-4">audience:</span><span class="hl-1"> </span><span class="hl-2">'myaudience'</span><span class="hl-1"> });</span>
</code><button type="button">Copy</button></pre>
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="pushedauthorization"><span>pushed<wbr/>Authorization</span><a href="#pushedauthorization" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="pushedauthorization-1"><span class="tsd-kind-call-signature">pushedAuthorization</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">bodyParameters</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/auth.PushedAuthorizationRequest.html" class="tsd-signature-type tsd-kind-interface">PushedAuthorizationRequest</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">initOverrides</span><span class="tsd-signature-symbol">?:</span> <a href="../types/lib.InitOverride.html" class="tsd-signature-type tsd-kind-type-alias">InitOverride</a> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="lib.JSONApiResponse.html" class="tsd-signature-type tsd-kind-class">JSONApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/auth.PushedAuthorizationResponse.html" class="tsd-signature-type tsd-kind-interface">PushedAuthorizationResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#pushedauthorization-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>This is the OAuth 2.0 extension that allows to initiate an OAuth flow from the backchannel instead of by building a URL.</p>
<p>See: <a href="https://www.rfc-editor.org/rfc/rfc9126.html">https://www.rfc-editor.org/rfc/rfc9126.html</a></p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">bodyParameters</span>: <a href="../interfaces/auth.PushedAuthorizationRequest.html" class="tsd-signature-type tsd-kind-interface">PushedAuthorizationRequest</a></span></li><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">initOverrides</span><span class="tsd-signature-symbol">?:</span> <a href="../types/lib.InitOverride.html" class="tsd-signature-type tsd-kind-type-alias">InitOverride</a> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="lib.JSONApiResponse.html" class="tsd-signature-type tsd-kind-class">JSONApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/auth.PushedAuthorizationResponse.html" class="tsd-signature-type tsd-kind-interface">PushedAuthorizationResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-3">Example<a href="#example-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="js"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">auth0</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">AuthenticationApi</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">domain:</span><span class="hl-1"> </span><span class="hl-2">'my-domain.auth0.com'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">clientId:</span><span class="hl-1"> </span><span class="hl-2">'myClientId'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">clientSecret:</span><span class="hl-1"> </span><span class="hl-2">'myClientSecret'</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">auth0</span><span class="hl-1">.</span><span class="hl-4">oauth</span><span class="hl-1">.</span><span class="hl-0">pushedAuthorization</span><span class="hl-1">({ </span><span class="hl-4">response_type:</span><span class="hl-1"> </span><span class="hl-2">'id_token'</span><span class="hl-1">, </span><span class="hl-4">redirect_uri:</span><span class="hl-1"> </span><span class="hl-2">'http://localhost'</span><span class="hl-1"> });</span>
</code><button type="button">Copy</button></pre>
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="passwordgrant"><span>password<wbr/>Grant</span><a href="#passwordgrant" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="passwordgrant-1"><span class="tsd-kind-call-signature">passwordGrant</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">bodyParameters</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/auth.PasswordGrantRequest.html" class="tsd-signature-type tsd-kind-interface">PasswordGrantRequest</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/auth.GrantOptions.html" class="tsd-signature-type tsd-kind-interface">GrantOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="lib.JSONApiResponse.html" class="tsd-signature-type tsd-kind-class">JSONApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/auth.TokenSet.html" class="tsd-signature-type tsd-kind-interface">TokenSet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#passwordgrant-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>This information is typically received from a highly trusted public client like a SPA*.
(<strong>*Note:</string> For single-page applications and native/mobile apps, we recommend using web flows instead.)</p>
<p>See: <a href="https://auth0.com/docs/api/authentication#resource-owner-password">https://auth0.com/docs/api/authentication#resource-owner-password</a></p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">bodyParameters</span>: <a href="../interfaces/auth.PasswordGrantRequest.html" class="tsd-signature-type tsd-kind-interface">PasswordGrantRequest</a></span></li><li><span><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/auth.GrantOptions.html" class="tsd-signature-type tsd-kind-interface">GrantOptions</a><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="lib.JSONApiResponse.html" class="tsd-signature-type tsd-kind-class">JSONApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/auth.TokenSet.html" class="tsd-signature-type tsd-kind-interface">TokenSet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-4">Example<a href="#example-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="js"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">auth0</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">AuthenticationApi</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">domain:</span><span class="hl-1"> </span><span class="hl-2">'my-domain.auth0.com'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">clientId:</span><span class="hl-1"> </span><span class="hl-2">'myClientId'</span><br/><span class="hl-1"> </span><span class="hl-4">clientSecret</span><span class="hl-1">: </span><span class="hl-2">'myClientSecret'</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">auth0</span><span class="hl-1">.</span><span class="hl-4">oauth</span><span class="hl-1">.</span><span class="hl-0">passwordGrant</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">username:</span><span class="hl-1"> </span><span class="hl-2">'myusername@example.com'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">password:</span><span class="hl-1"> </span><span class="hl-2">'mypassword'</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> { </span><span class="hl-4">initOverrides:</span><span class="hl-1"> { </span><span class="hl-4">headers:</span><span class="hl-1"> { </span><span class="hl-2">'auth0-forwarded-for'</span><span class="hl-4">:</span><span class="hl-1"> </span><span class="hl-2">'END.USER.IP.123'</span><span class="hl-1"> } } }</span><br/><span class="hl-1">);</span>
</code><button type="button">Copy</button></pre>
<p>Set the'auth0-forwarded-for' header to the end-user IP as a string value if you want
brute-force protection to work in server-side scenarios.</p>
<p>See <a href="https://auth0.com/docs/get-started/authentication-and-authorization-flow/avoid-common-issues-with-resource-owner-password-flow-and-attack-protection">https://auth0.com/docs/get-started/authentication-and-authorization-flow/avoid-common-issues-with-resource-owner-password-flow-and-attack-protection</a></p>
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="refreshtokengrant"><span>refresh<wbr/>Token<wbr/>Grant</span><a href="#refreshtokengrant" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="refreshtokengrant-1"><span class="tsd-kind-call-signature">refreshTokenGrant</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">bodyParameters</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/auth.RefreshTokenGrantRequest.html" class="tsd-signature-type tsd-kind-interface">RefreshTokenGrantRequest</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/auth.GrantOptions.html" class="tsd-signature-type tsd-kind-interface">GrantOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="lib.JSONApiResponse.html" class="tsd-signature-type tsd-kind-class">JSONApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/auth.TokenSet.html" class="tsd-signature-type tsd-kind-interface">TokenSet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#refreshtokengrant-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Use this endpoint to refresh an Access Token using the Refresh Token you got during authorization.</p>
<p>See: <a href="https://auth0.com/docs/api/authentication#refresh-token">https://auth0.com/docs/api/authentication#refresh-token</a></p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">bodyParameters</span>: <a href="../interfaces/auth.RefreshTokenGrantRequest.html" class="tsd-signature-type tsd-kind-interface">RefreshTokenGrantRequest</a></span></li><li><span><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/auth.GrantOptions.html" class="tsd-signature-type tsd-kind-interface">GrantOptions</a><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="lib.JSONApiResponse.html" class="tsd-signature-type tsd-kind-class">JSONApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/auth.TokenSet.html" class="tsd-signature-type tsd-kind-interface">TokenSet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-5">Example<a href="#example-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="js"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">auth0</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">AuthenticationApi</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">domain:</span><span class="hl-1"> </span><span class="hl-2">'my-domain.auth0.com'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">clientId:</span><span class="hl-1"> </span><span class="hl-2">'myClientId'</span><br/><span class="hl-1"> </span><span class="hl-4">clientSecret</span><span class="hl-1">: </span><span class="hl-2">'myClientSecret'</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">auth0</span><span class="hl-1">.</span><span class="hl-4">oauth</span><span class="hl-1">.</span><span class="hl-0">refreshTokenGrant</span><span class="hl-1">({ </span><span class="hl-4">refresh_token:</span><span class="hl-1"> </span><span class="hl-2">'myrefreshtoken'</span><span class="hl-1"> })</span>
</code><button type="button">Copy</button></pre>
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="revokerefreshtoken"><span>revoke<wbr/>Refresh<wbr/>Token</span><a href="#revokerefreshtoken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="revokerefreshtoken-1"><span class="tsd-kind-call-signature">revokeRefreshToken</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">bodyParameters</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/auth.RevokeRefreshTokenRequest.html" class="tsd-signature-type tsd-kind-interface">RevokeRefreshTokenRequest</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">initOverrides</span><span class="tsd-signature-symbol">?:</span> <a href="../types/lib.InitOverride.html" class="tsd-signature-type tsd-kind-type-alias">InitOverride</a> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="lib.VoidApiResponse.html" class="tsd-signature-type tsd-kind-class">VoidApiResponse</a><span class="tsd-signature-symbol">></span><a href="#revokerefreshtoken-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Use this endpoint to invalidate a Refresh Token if it has been compromised.</p>
<p>The behaviour of this endpoint depends on the state of the <a href="https://auth0.com/docs/secure/tokens/refresh-tokens/revoke-refresh-tokens#refresh-tokens-and-grants">Refresh Token Revocation Deletes Grant</a> toggle.
If this toggle is enabled, then each revocation request invalidates not only the specific token, but all other tokens based on the same authorization grant.
This means that all Refresh Tokens that have been issued for the same user, application, and audience will be revoked.
If this toggle is disabled, then only the refresh token is revoked, while the grant is left intact.</p>
<p>See: <a href="https://auth0.com/docs/api/authentication#revoke-refresh-token">https://auth0.com/docs/api/authentication#revoke-refresh-token</a></p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">bodyParameters</span>: <a href="../interfaces/auth.RevokeRefreshTokenRequest.html" class="tsd-signature-type tsd-kind-interface">RevokeRefreshTokenRequest</a></span></li><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">initOverrides</span><span class="tsd-signature-symbol">?:</span> <a href="../types/lib.InitOverride.html" class="tsd-signature-type tsd-kind-type-alias">InitOverride</a> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="lib.VoidApiResponse.html" class="tsd-signature-type tsd-kind-class">VoidApiResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-6">Example<a href="#example-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="js"><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">auth0</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">AuthenticationApi</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">domain:</span><span class="hl-1"> </span><span class="hl-2">'my-domain.auth0.com'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">clientId:</span><span class="hl-1"> </span><span class="hl-2">'myClientId'</span><br/><span class="hl-1"> </span><span class="hl-4">clientSecret</span><span class="hl-1">: </span><span class="hl-2">'myClientSecret'</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">auth0</span><span class="hl-1">.</span><span class="hl-4">oauth</span><span class="hl-1">.</span><span class="hl-0">revokeRefreshToken</span><span class="hl-1">({ </span><span class="hl-4">token:</span><span class="hl-1"> </span><span class="hl-2">'myrefreshtoken'</span><span class="hl-1"> })</span>
</code><button type="button">Copy</button></pre>
</div></div></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="tokenforconnection"><span>token<wbr/>For<wbr/>Connection</span><a href="#tokenforconnection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="tokenforconnection-1"><span class="tsd-kind-call-signature">tokenForConnection</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">bodyParameters</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/auth.TokenForConnectionRequest.html" class="tsd-signature-type tsd-kind-interface">TokenForConnectionRequest</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">initOverrides</span><span class="tsd-signature-symbol">?:</span> <a href="../types/lib.InitOverride.html" class="tsd-signature-type tsd-kind-type-alias">InitOverride</a> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="lib.JSONApiResponse.html" class="tsd-signature-type tsd-kind-class">JSONApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/auth.TokenSet.html" class="tsd-signature-type tsd-kind-interface">TokenSet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#tokenforconnection-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Exchanges a subject token for an access token for the connection.</p>
<p>The request body includes:</p>
<ul>
<li>client_id (and client_secret/client_assertion via addClientAuthentication)</li>
<li>grant_type set to <code>urn:auth0:params:oauth:grant-type:token-exchange:federated-connection-access-token</code></li>
<li>subject_token: the token to exchange</li>
<li>subject_token_type: the type of token being exchanged. Defaults to refresh tokens (<code>urn:ietf:params:oauth:token-type:refresh_token</code>).</li>
<li>requested_token_type (<code>http://auth0.com/oauth/token-type/federated-connection-access-token</code>) indicating that a federated connection access token is desired</li>
<li>connection name and an optional <code>login_hint</code> if provided</li>
</ul>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">bodyParameters</span>: <a href="../interfaces/auth.TokenForConnectionRequest.html" class="tsd-signature-type tsd-kind-interface">TokenForConnectionRequest</a></span><div class="tsd-comment tsd-typography"><p>The options to retrieve a token for a connection.</p>
</div></li><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">initOverrides</span><span class="tsd-signature-symbol">?:</span> <a href="../types/lib.InitOverride.html" class="tsd-signature-type tsd-kind-type-alias">InitOverride</a> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="lib.JSONApiResponse.html" class="tsd-signature-type tsd-kind-class">JSONApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/auth.TokenSet.html" class="tsd-signature-type tsd-kind-interface">TokenSet</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><p>A promise with the token response data.</p>
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws">Throws<a href="#throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>An error if the exchange fails.</p>
</div></div></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><h3 class="tsd-anchor-link" id="request"><code class="tsd-tag">Protected</code><span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-protected tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link" id="request-1"><span class="tsd-kind-call-signature">request</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/lib.RequestOpts.html" class="tsd-signature-type tsd-kind-interface">RequestOpts</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">initOverrides</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">RequestInit</span> <span class="tsd-signature-symbol">|</span> <a href="../types/lib.InitOverrideFunction.html" class="tsd-signature-type tsd-kind-type-alias">InitOverrideFunction</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span><a href="#request-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">context</span>: <a href="../interfaces/lib.RequestOpts.html" class="tsd-signature-type tsd-kind-interface">RequestOpts</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">initOverrides</span>: <span class="tsd-signature-type">RequestInit</span> <span class="tsd-signature-symbol">|</span> <a href="../types/lib.InitOverrideFunction.html" class="tsd-signature-type tsd-kind-type-alias">InitOverrideFunction</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Inherited from <a href="auth.SDK.BaseAuthAPI.html">BaseAuthAPI</a>.<a href="auth.SDK.BaseAuthAPI.html#request">request</a></p></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="domain"><span>domain</span><a href="#domain" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">domain</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="auth.SDK.BaseAuthAPI.html">BaseAuthAPI</a>.<a href="auth.SDK.BaseAuthAPI.html#domain">domain</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="clientid"><span>client<wbr/>Id</span><a href="#clientid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">clientId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="auth.SDK.BaseAuthAPI.html">BaseAuthAPI</a>.<a href="auth.SDK.BaseAuthAPI.html#clientid">clientId</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="clientsecret"><code class="tsd-tag">Optional</code><span>client<wbr/>Secret</span><a href="#clientsecret" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">clientSecret</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="auth.SDK.BaseAuthAPI.html">BaseAuthAPI</a>.<a href="auth.SDK.BaseAuthAPI.html#clientsecret">clientSecret</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="clientassertionsigningkey"><code class="tsd-tag">Optional</code><span>client<wbr/>Assertion<wbr/>Signing<wbr/>Key</span><a href="#clientassertionsigningkey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">clientAssertionSigningKey</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="auth.SDK.BaseAuthAPI.html">BaseAuthAPI</a>.<a href="auth.SDK.BaseAuthAPI.html#clientassertionsigningkey">clientAssertionSigningKey</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="clientassertionsigningalg"><code class="tsd-tag">Optional</code><span>client<wbr/>Assertion<wbr/>Signing<wbr/>Alg</span><a href="#clientassertionsigningalg" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">clientAssertionSigningAlg</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="auth.SDK.BaseAuthAPI.html">BaseAuthAPI</a>.<a href="auth.SDK.BaseAuthAPI.html#clientassertionsigningalg">clientAssertionSigningAlg</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="usemtls"><code class="tsd-tag">Optional</code><span>use<wbr/>MTLS</span><a href="#usemtls" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">useMTLS</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="auth.SDK.BaseAuthAPI.html">BaseAuthAPI</a>.<a href="auth.SDK.BaseAuthAPI.html#usemtls">useMTLS</a></p></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="idtokenvalidator"><code class="tsd-tag">Readonly</code><span>id<wbr/>Token<wbr/>Validator</span><a href="#idtokenvalidator" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">idTokenValidator</span><span class="tsd-signature-symbol">:</span> <a href="auth.SDK.IDTokenValidator.html" class="tsd-signature-type tsd-kind-class">IDTokenValidator</a></div></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><h3 class="tsd-anchor-link" id="configuration"><code class="tsd-tag">Protected</code><span>configuration</span><a href="#configuration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">configuration</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/lib.Configuration.html" class="tsd-signature-type tsd-kind-interface">Configuration</a></div><aside class="tsd-sources"><p>Inherited from <a href="auth.SDK.BaseAuthAPI.html">BaseAuthAPI</a>.<a href="auth.SDK.BaseAuthAPI.html#configuration">configuration</a></p></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#authorizationcodegrant"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>authorization<wbr/>Code<wbr/>Grant</span></a><a href="#authorizationcodegrantwithpkce"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>authorization<wbr/>Code<wbr/>Grant<wbr/>With<wbr/>PKCE</span></a><a href="#clientcredentialsgrant"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>client<wbr/>Credentials<wbr/>Grant</span></a><a href="#pushedauthorization"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pushed<wbr/>Authorization</span></a><a href="#passwordgrant"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>password<wbr/>Grant</span></a><a href="#refreshtokengrant"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>refresh<wbr/>Token<wbr/>Grant</span></a><a href="#revokerefreshtoken"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>revoke<wbr/>Refresh<wbr/>Token</span></a><a href="#tokenforconnection"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>token<wbr/>For<wbr/>Connection</span></a><a href="#request" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>request</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#domain" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>domain</span></a><a href="#clientid" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>client<wbr/>Id</span></a><a href="#clientsecret" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>client<wbr/>Secret</span></a><a href="#clientassertionsigningkey" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>client<wbr/>Assertion<wbr/>Signing<wbr/>Key</span></a><a href="#clientassertionsigningalg" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>client<wbr/>Assertion<wbr/>Signing<wbr/>Alg</span></a><a href="#usemtls" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>use<wbr/>MTLS</span></a><a href="#idtokenvalidator"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id<wbr/>Token<wbr/>Validator</span></a><a href="#configuration" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>configuration</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Auth0 Node.js SDK - v5.10.0</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>