Skip to content

Commit

Permalink
Merge branch 'master' into fix-examples
Browse files Browse the repository at this point in the history
  • Loading branch information
frederikprijck authored Jun 20, 2024
2 parents 28b8a28 + 783c432 commit cc3df47
Show file tree
Hide file tree
Showing 1,027 changed files with 5,788 additions and 5,325 deletions.
2 changes: 1 addition & 1 deletion .version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v4.3.1
v4.5.0
34 changes: 34 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,39 @@
# Change Log

## [v4.5.0](https://github.com/auth0/node-auth0/tree/v4.5.0) (2024-06-14)

[Full Changelog](https://github.com/auth0/node-auth0/compare/v4.4.1...v4.5.0)

**Changed**

- Support signing up with organization membership. [\#1012](https://github.com/auth0/node-auth0/pull/1012) ([nandan-bhat](https://github.com/nandan-bhat))

**⚠️ BREAKING CHANGES**

- Changes to `ResourceServer` interfaces (`ResourceServerTokenDialectEnum`, `ResourceServerCreateTokenDialectEnum` and `ResourceServerUpdateTokenDialectEnum`). [\#1012](https://github.com/auth0/node-auth0/pull/1012) ([nandan-bhat](https://github.com/nandan-bhat))
- The key `token` is changed to `access_token`.
- The key `token_authz` is changed to `access_token_authz`.

## [v4.4.1](https://github.com/auth0/node-auth0/tree/v4.4.1) (2024-06-11)

[Full Changelog](https://github.com/auth0/node-auth0/compare/v4.4.0...v4.4.1)

**Fixed**

- fix: Fixed undici-types error by updating the dependecy [\#1008](https://github.com/auth0/node-auth0/pull/1008) ([gyaneshgouraw-okta](https://github.com/gyaneshgouraw-okta))

## [v4.4.0](https://github.com/auth0/node-auth0/tree/v4.4.0) (2024-05-07)

[Full Changelog](https://github.com/auth0/node-auth0/compare/v4.3.1...v4.4.0)

**Added**

- Added new values of token_dialect in management api generated section [\#1003](https://github.com/auth0/node-auth0/pull/1003) ([gyaneshgouraw-okta](https://github.com/gyaneshgouraw-okta))
- Added changes to support mTLS authentication [\#1002](https://github.com/auth0/node-auth0/pull/1002) ([gyaneshgouraw-okta](https://github.com/gyaneshgouraw-okta))
- Added additional request parameter to support PAR with JAR requests [\#995](https://github.com/auth0/node-auth0/pull/995) ([gyaneshgouraw-okta](https://github.com/gyaneshgouraw-okta))
- Added new authorization_details parameter to support RAR requests [\#997](https://github.com/auth0/node-auth0/pull/997) ([gyaneshgouraw-okta](https://github.com/gyaneshgouraw-okta))
- Bump jose from 4.14.4 to 4.15.5 [\#993](https://github.com/auth0/node-auth0/pull/993) ([dependabot[bot]](https://github.com/apps/dependabot))

## [v4.3.1](https://github.com/auth0/node-auth0/tree/v4.3.1) (2024-02-09)

[Full Changelog](https://github.com/auth0/node-auth0/compare/v4.3.0...v4.3.1)
Expand Down
23 changes: 23 additions & 0 deletions EXAMPLES.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
- [Use Refresh Tokens](#use-refresh-tokens)
- [Complete the Authorization Code flow with PKCE](#complete-the-authorization-code-flow-with-pkce)
- [Login with Passwordless](#login-with-passwordless)
- [mTLS request](#mtls-request)
- [Management Client](#management-client)
- [Paginate through a list of users](#paginate-through-a-list-of-users)
- [Paginate through a list of logs using checkpoint pagination](#paginate-through-a-list-of-logs-using-checkpoint-pagination)
Expand Down Expand Up @@ -129,6 +130,28 @@ const { data: tokens } = await auth.passwordless.loginWithEmail({
});
```

### mTLS request

Refer mTLS documentation for more info - [Link](https://auth0.com/docs/get-started/authentication-and-authorization-flow/authenticate-with-mtls)

```js
import { AuthenticationClient } from 'auth0';
const { Agent } = require('undici');

const auth = new AuthenticationClient({
domain: '{YOUR_TENANT_AND REGION}.auth0.com',
clientId: '{YOUR_CLIENT_ID}',
agent: new Agent({
connect: { cert: 'your_cert', key: 'your_key' },
}),
useMTLS: true,
});

const { data: tokens } = await auth.oauth.clientCredentialsGrant({
audience: 'you-api',
});
```

## Management Client

### Paginate through a list of users
Expand Down
2 changes: 1 addition & 1 deletion docs/assets/search.js

Large diffs are not rendered by default.

18 changes: 9 additions & 9 deletions docs/classes/auth.AuthApiError.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">AuthApiError</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/657c3961/src/auth/base-auth-api.ts#L32">src/auth/base-auth-api.ts:32</a></li></ul></aside>
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/b79404e9/src/auth/base-auth-api.ts#L33">src/auth/base-auth-api.ts:33</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand Down Expand Up @@ -73,29 +73,29 @@ <h5><span class="tsd-kind-parameter">headers</span>: <span class="tsd-signature-
<h4 class="tsd-returns-title">Returns <a href="auth.AuthApiError.html" class="tsd-signature-type tsd-kind-class">AuthApiError</a></h4><aside class="tsd-sources">
<p>Overrides Error.constructor</p>
<ul>
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/657c3961/src/auth/base-auth-api.ts#L34">src/auth/base-auth-api.ts:34</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/b79404e9/src/auth/base-auth-api.ts#L35">src/auth/base-auth-api.ts:35</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Properties</h2>
<section class="tsd-panel tsd-member"><a id="body" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>body</span><a href="#body" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">body</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/657c3961/src/auth/base-auth-api.ts#L38">src/auth/base-auth-api.ts:38</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/b79404e9/src/auth/base-auth-api.ts#L39">src/auth/base-auth-api.ts:39</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="error" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>error</span><a href="#error" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/657c3961/src/auth/base-auth-api.ts#L35">src/auth/base-auth-api.ts:35</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/b79404e9/src/auth/base-auth-api.ts#L36">src/auth/base-auth-api.ts:36</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="error_description" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>error_<wbr/>description</span><a href="#error_description" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">error_<wbr/>description</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/657c3961/src/auth/base-auth-api.ts#L36">src/auth/base-auth-api.ts:36</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/b79404e9/src/auth/base-auth-api.ts#L37">src/auth/base-auth-api.ts:37</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="headers" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>headers</span><a href="#headers" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">headers</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Headers</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/657c3961/src/auth/base-auth-api.ts#L39">src/auth/base-auth-api.ts:39</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/b79404e9/src/auth/base-auth-api.ts#L40">src/auth/base-auth-api.ts:40</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
Expand All @@ -107,7 +107,7 @@ <h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permali
<div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;AuthApiError&quot;</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
<p>Overrides Error.name</p>
<ul>
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/657c3961/src/auth/base-auth-api.ts#L33">src/auth/base-auth-api.ts:33</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/b79404e9/src/auth/base-auth-api.ts#L34">src/auth/base-auth-api.ts:34</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">stack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
Expand All @@ -118,7 +118,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code
<h3 class="tsd-anchor-link"><span>status<wbr/>Code</span><a href="#statusCode" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">status<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/657c3961/src/auth/base-auth-api.ts#L37">src/auth/base-auth-api.ts:37</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/auth0/node-auth0/blob/b79404e9/src/auth/base-auth-api.ts#L38">src/auth/base-auth-api.ts:38</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prepareStackTrace" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>prepare<wbr/>Stack<wbr/>Trace</span><a href="#prepareStackTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">prepare<wbr/>Stack<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">stackTraces</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div>
Expand Down Expand Up @@ -550,7 +550,6 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.9389
<li><a href="../interfaces/management.GetEmailTemplatesByTemplateNameRequest.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Get<wbr/>Email<wbr/>Templates<wbr/>By<wbr/>Template<wbr/>Name<wbr/>Request</span></a></li>
<li><a href="../interfaces/management.GetEnabledConnections200ResponseOneOf.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Get<wbr/>Enabled<wbr/>Connections200<wbr/>Response<wbr/>One<wbr/>Of</span></a></li>
<li><a href="../interfaces/management.GetEnabledConnections200ResponseOneOfInner.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Get<wbr/>Enabled<wbr/>Connections200<wbr/>Response<wbr/>One<wbr/>Of<wbr/>Inner</span></a></li>
<li><a href="../interfaces/management.GetEnabledConnections200ResponseOneOfInnerConnection.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Get<wbr/>Enabled<wbr/>Connections200<wbr/>Response<wbr/>One<wbr/>Of<wbr/>Inner<wbr/>Connection</span></a></li>
<li><a href="../interfaces/management.GetEnabledConnectionsByConnectionIdRequest.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Get<wbr/>Enabled<wbr/>Connections<wbr/>By<wbr/>Connection<wbr/>Id<wbr/>Request</span></a></li>
<li><a href="../interfaces/management.GetEnabledConnectionsRequest.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Get<wbr/>Enabled<wbr/>Connections<wbr/>Request</span></a></li>
<li><a href="../interfaces/management.GetEnrollmentsByIdRequest.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Get<wbr/>Enrollments<wbr/>By<wbr/>Id<wbr/>Request</span></a></li>
Expand Down Expand Up @@ -774,6 +773,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.9389
<li><a href="../interfaces/management.PostOrganizationMemberRolesRequest.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Post<wbr/>Organization<wbr/>Member<wbr/>Roles<wbr/>Request</span></a></li>
<li><a href="../interfaces/management.PostOrganizations201Response.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Post<wbr/>Organizations201<wbr/>Response</span></a></li>
<li><a href="../interfaces/management.PostOrganizations201ResponseEnabledConnectionsInner.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Post<wbr/>Organizations201<wbr/>Response<wbr/>Enabled<wbr/>Connections<wbr/>Inner</span></a></li>
<li><a href="../interfaces/management.PostOrganizations201ResponseEnabledConnectionsInnerConnection.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Post<wbr/>Organizations201<wbr/>Response<wbr/>Enabled<wbr/>Connections<wbr/>Inner<wbr/>Connection</span></a></li>
<li><a href="../interfaces/management.PostOrganizationsRequest.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Post<wbr/>Organizations<wbr/>Request</span></a></li>
<li><a href="../interfaces/management.PostOrganizationsRequestBranding.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Post<wbr/>Organizations<wbr/>Request<wbr/>Branding</span></a></li>
<li><a href="../interfaces/management.PostOrganizationsRequestEnabledConnectionsInner.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Post<wbr/>Organizations<wbr/>Request<wbr/>Enabled<wbr/>Connections<wbr/>Inner</span></a></li>
Expand Down
Loading

0 comments on commit cc3df47

Please sign in to comment.