Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix link to examples from docs site #970

Merged
merged 1 commit into from
Nov 16, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ const auth0 = new AuthenticationClient({
});
```

See [more examples](./EXAMPLES.md#authentication-client).
See [more examples](https://github.com/auth0/node-auth0/blob/master/EXAMPLES.md#authentication-client).

#### Management API Client

Expand Down Expand Up @@ -73,7 +73,7 @@ var management = new ManagementClient({
});
```

See [more examples](./EXAMPLES.md#management-client).
See [more examples](https://github.com/auth0/node-auth0/blob/master/EXAMPLES.md#management-client).

## API Reference

Expand Down
4 changes: 2 additions & 2 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,15 @@ <h2>auth0</h2></div>
<a id="md:configure-the-sdk" class="tsd-anchor"></a><h3><a href="#md:configure-the-sdk">Configure the SDK</a></h3><a id="md:authentication-api-client" class="tsd-anchor"></a><h4><a href="#md:authentication-api-client">Authentication API Client</a></h4><p>This client can be used to access Auth0&#39;s <a href="https://auth0.com/docs/api/authentication">Authentication API</a>.</p>
<pre><code class="language-js"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">AuthenticationClient</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&#39;auth0&#39;</span><span class="hl-1">;</span><br/><br/><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">AuthenticationClient</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">&#39;{YOUR_ACCOUNT}.auth0.com&#39;</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">&#39;{OPTIONAL_CLIENT_ID}&#39;</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">&#39;{OPTIONAL_CLIENT_SECRET}&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">});</span>
</code><button>Copy</button></pre>
<p>See <a href="./EXAMPLES.md#authentication-client">more examples</a>.</p>
<p>See <a href="https://github.com/auth0/node-auth0/blob/master/EXAMPLES.md#authentication-client">more examples</a>.</p>
<a id="md:management-api-client" class="tsd-anchor"></a><h4><a href="#md:management-api-client">Management API Client</a></h4><p>The Auth0 Management API is meant to be used by back-end servers or trusted parties performing administrative tasks. Generally speaking, anything that can be done through the Auth0 dashboard (and more) can also be done through this API.</p>
<p>Initialize your client class with a client ID, client secret and a domain.</p>
<pre><code class="language-js"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">ManagementClient</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&#39;auth0&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-5">var</span><span class="hl-1"> </span><span class="hl-4">management</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">ManagementClient</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">&#39;{YOUR_TENANT_AND REGION}.auth0.com&#39;</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">&#39;{YOUR_CLIENT_ID}&#39;</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">&#39;{YOUR_CLIENT_SECRET}&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">});</span>
</code><button>Copy</button></pre>
<p>Or, initialize your client class with an API v2 token and a domain.</p>
<pre><code class="language-js"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">ManagementClient</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&#39;auth0&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-5">var</span><span class="hl-1"> </span><span class="hl-4">management</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">ManagementClient</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">&#39;{YOUR_TENANT_AND REGION}.auth0.com&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">token:</span><span class="hl-1"> </span><span class="hl-2">&#39;{YOUR_API_V2_TOKEN}&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">});</span>
</code><button>Copy</button></pre>
<p>See <a href="./EXAMPLES.md#management-client">more examples</a>.</p>
<p>See <a href="https://github.com/auth0/node-auth0/blob/master/EXAMPLES.md#management-client">more examples</a>.</p>
<a id="md:api-reference" class="tsd-anchor"></a><h2><a href="#md:api-reference">API Reference</a></h2><ul>
<li><a href="https://auth0.github.io/node-auth0/classes/auth.AuthenticationClient.html">AuthenticationClient</a></li>
<li><a href="https://auth0.github.io/node-auth0/classes/management.ManagementClient.html">ManagementClient</a></li>
Expand Down