Skip to content

Commit 38d3e37

Browse files
harishsundar-oktaharishsundar-okta
committed
create locale folders of quickstarts
1 parent c4cba3c commit 38d3e37

File tree

4,388 files changed

+325538
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

4,388 files changed

+325538
-0
lines changed

‎fr-ca/articles/_includes/_api-auth-customize-tokens.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
You can use [Rules](/rules) to change the returned scopes of the Access Token and/or add claims to it (and the ID Token) with a script like this:
2+
3+
```javascript
4+
function(user, context, callback) {
5+
6+
// add custom claims to Access Token and ID Token
7+
context.accessToken['http://foo/bar'] = 'value';
8+
context.idToken['http://fiz/baz'] = 'some other value';
9+
10+
// change scope
11+
context.accessToken.scope = ['array', 'of', 'strings'];
12+
13+
callback(null, user, context);
14+
}
15+
```
16+
17+
::: panel-warning Namespacing Custom Claims
18+
Auth0 returns profile information in a [structured claim format as defined by the OpenID Connect (OIDC) specification](https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims). This means that in order to add custom claims to ID Tokens or Access Tokens, they must [conform to a namespaced format](/tokens/guides/create-namespaced-custom-claims) to avoid possible collisions with standard OIDC claims. You can [add namespaced claims using Rules](#optional-customize-the-tokens).
19+
:::

‎fr-ca/articles/_includes/_api_auth_intro.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
::: note
2+
**New to Auth0?** Learn [how Auth0 works](/overview) and read about [implementing API authentication and authorization ](/api-auth) using the OAuth 2.0 framework.
3+
:::

‎fr-ca/articles/_includes/_boxed.html

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<div class="boxed">
2+
<h3 class="title">
3+
<a href="#" class="feature">
4+
<span class="section-name">Logs</span>
5+
</a>
6+
</h3>
7+
<ul class="list clearfix">
8+
<div class="clearfix">
9+
<li data-toggle="popover" class="info" title="">Review the logged data of both actions taken in the dashboard by the administrators, as well as authentications made by your users.</li>
10+
<li data-toggle="popover" class="info" title="">Facilitate diagnosis and resolution of authentication issues.</li>
11+
</div>
12+
<div class="clearfix">
13+
<li data-toggle="popover" class="info" title="">Longer Storage of log data for your apps.</li>
14+
</div>
15+
</ul>
16+
<p class="log-retention-notice">Your current subscription allows to keep your logs for the last <span class="archive-days">30</span> days.</p>
17+
</div>

‎fr-ca/articles/_includes/_callback_url.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<!-- markdownlint-disable MD002 MD041 -->
2+
3+
### Configure Callback URLs
4+
5+
A callback URL is a URL in your application where Auth0 redirects the user after they have authenticated. The callback URL for your app must be added to the **Allowed Callback URLs** field in your [Application Settings](${manage_url}/#/applications). If this field is not set, users will be unable to log in to the application and will get an error.

‎fr-ca/articles/_includes/_calling_apis.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
A common need for any client-side application is to access resources from a data API. Some of these data resources will likely need to be protected such that only the user who is authenticated in the client-side app can access them. This can be achieved by protecting your API's endpoints with your Auth0 secret key and sending the user's JWT as an `Authorization` header when calling the API. For more detail on how to secure your API, see the [server API documentation](/quickstart/backend).

‎fr-ca/articles/_includes/_checksession_polling.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
In some multi-application scenarios, where Single Logout is desired (a user logging out of one application needs to be logged out of other applications), an application can be set up to periodically poll Auth0 using `checkSession()` to see if a session exists. If the session does not exist, you can then log the user out of the application. The same polling method can be used to implement silent authentication for a <dfn data-key="single-sign-on">Single Sign-on (SSO)</dfn> scenario.
2+
3+
The poll interval between checks to `checkSession()` should be at least 15 minutes between calls to avoid any issues in the future with rate limiting of this call.

‎fr-ca/articles/_includes/_co_authenticate_errors.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
## Error Codes and Descriptions
2+
3+
When ${library} is used for embedded login, it employs the /co/authenticate endpoint, which has the following errors.
4+
5+
::: warning
6+
The error description is human readable. It **should not be parsed by any code** and it subject to change at any time.
7+
:::
8+
9+
| Status | Code | Description |
10+
| --- | --- | --- | --- |
11+
| 400 | invalid_request | Invalid request body. All and only of client_id, credential_type, username, otp, realm are required. |
12+
| 401 | unauthorized_client | Cross origin login not allowed. |
13+
| 400 | unsupported_credential_type | Unknown credential type parameter. |
14+
| 400 | invalid_request | Unknown realm non-existent-connection. |
15+
| 403 | access_denied | Wrong email or password. |
16+
| 403 | access_denied | Authentication error |
17+
| 403 | blocked_user | Blocked user |
18+
| 401 | password_leaked | This login attempt has been blocked because the password you're using was previously disclosed through a data breach (not in this application). |
19+
| 429 | too_many_attempts | Your account has been blocked after multiple consecutive login attempts. We’ve sent you an email with instructions on how to unblock it. |
20+
| 429 | too_many_attempts | We have detected suspicious login behavior and further attempts will be blocked. Please contact the administrator. |
21+
22+
In addition, you can also get a generic 403 error without an `error` or `error_description` property. The response body would just include something similar to the following:
23+
24+
```text
25+
Origin https://test.app is not allowed.
26+
```

‎fr-ca/articles/_includes/_compat_warning.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
::: panel-warning Compatibility Warning
2+
With the new OAuth 2.0 API Authorization features in Auth0, not everything is fully backwards compatible, including 3rd party hosted Lock. This quickstart tutorial uses Auth0 hosted Lock instead.
3+
:::

‎fr-ca/articles/_includes/_contact-sales.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## More Information
2+
3+
If you have specific support requirements or need more information about the Professional Services we offer, please [contact Auth0 Sales](https://auth0.com/get-started?place=documentation%20post&type=link&text=contact%20auth0%20sales).

‎fr-ca/articles/_includes/_create_resource_server.md

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
## Create the API
2+
3+
Your resource server (API) needs to be configured to verify the Access Token and any claims contained within it. When you create a resource server in your Auth0 dashboard, it utilizes the RS256 signature method by default, meaning that Access Tokens are signed using Auth0's private key for your account. Verification is done using the corresponding public key. You can read more about the [JSON Web Key Set (JWKS)](/tokens/concepts/jwks) standard and also view the [public key(s)](https://${account.namespace}/.well-known/jwks.json) for your Auth0 account (https://${account.namespace}/.well-known/jwks.json). You can also learn how to [manage your signing keys](/tokens/guides/manage-signing-keys).
4+
5+
You can use any [recommended JWT library](https://jwt.io) to validate the standard claims returned in the token. The following example will demonstrate how to create a resource server API with Node. You can find more information about resource server implementations in the [Access Token documentation](https://auth0.com/docs/api-auth/config/asking-for-access-tokens).
6+
7+
The Access Token for your API must be verified against your JSON Web Key Set (JWKS) endpoint. This can be done easily with the **jwks-rsa** library available on npm.
8+
9+
Install the dependencies.
10+
11+
```bash
12+
npm install express express-jwt jwks-rsa
13+
```
14+
15+
Create a middleware which uses **express-jwt** and **jwks-rsa** to verify the Access Token against your JWKS endpoint.
16+
17+
```js
18+
const express = require('express');
19+
const app = express();
20+
const jwt = require('express-jwt');
21+
const jwksRsa = require('jwks-rsa');
22+
23+
const authenticate = jwt({
24+
// Dynamically provide a signing key based on the kid in the header and the signing keys provided by the JWKS endpoint.
25+
secret: jwksRsa.expressJwtSecret({
26+
cache: true,
27+
rateLimit: true,
28+
jwksRequestsPerMinute: 5,
29+
jwksUri: 'https://${account.namespace}/.well-known/jwks.json'
30+
}),
31+
32+
// Validate the audience and the issuer.
33+
audience: '{API IDENTIFIER}',
34+
issuer: 'https://${account.namespace}/',
35+
algorithms: ['RS256']
36+
});
37+
38+
app.get('/api/public', function(req, res) {
39+
res.json({ message: "Hello from a public endpoint! You don't need to be authenticated to see this." });
40+
});
41+
42+
app.get('/api/private', authenticate, function(req, res) {
43+
res.json({ message: "Hello from a private endpoint! You DO need to be authenticated to see this." });
44+
});
45+
46+
app.listen(3001);
47+
console.log('Listening on http://localhost:3001');
48+
```
49+
50+
Note that you **must** provide the `audience` for your API. This is the identifier you set for it when you create an API in your Auth0 dashboard.

‎fr-ca/articles/_includes/_deprecate-delegation.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
::: warning
2+
By default, delegation is disabled for tenants without an add-on in use as of 8 June 2017. Legacy tenants who currently use an add-on that requires delegation may continue to use this feature. If delegation functionality is changed or removed from service at some point, customers who currently use it will be notified beforehand and given ample time to migrate.
3+
:::

‎fr-ca/articles/_includes/_deprecate-impersonation.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
::: warning
2+
Impersonation has been deprecated and will not be enabled for new customers. The functionality will continue to work for existing customers who currently have it enabled. If at some point the impersonation feature is changed or removed from service, customers who currently use it will be notified beforehand and given ample time to migrate.
3+
:::

‎fr-ca/articles/_includes/_email-domain-blacklist.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
::: warning
2+
Auth0 blacklists certain "false" domains commonly used during testing. Use real email addresses to avoid disruption or `domain is blacklisted` errors.
3+
:::

‎fr-ca/articles/_includes/_embedded_login_warning.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
::: warning
2+
Embedded login for web uses Cross Origin Authentication. In some browsers [this can be unreliable](/cross-origin-authentication#limitations) if you do not set up a [Custom Domain](/custom-domains) **and host your app on the same domain**. Using Custom Domains with Auth0 is a paid feature. If you cannot use Custom Domains, consider [migrating to Universal Login](/guides/login/migration-embedded-universal).
3+
:::

‎fr-ca/articles/_includes/_enable-third-party-apps-info.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
::: note
2+
To use this feature, you must [enable third-party applications for your Auth0 tenant](/applications/guides/enable-third-party-apps).
3+
:::

‎fr-ca/articles/_includes/_enforce-claim-namespacing.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
::: warning
2+
By default, Auth0 always enforces namespacing; any custom claims with non-namespaced identifiers will be silently excluded from tokens.
3+
4+
We do allow non-OIDC claims without a namespace for legacy tenants using a non-OIDC-conformant pipeline with the **Legacy User Profile** enabled, but we strongly recommend that legacy tenants migrate to an OIDC-conformant flow.
5+
:::

‎fr-ca/articles/_includes/_http-method.html

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
<h3 class="http-method-box">
2+
<span class="badge ${http_badge.toLowerCase()}" href="${link}">${http_method}</span>
3+
<span class="path" href="${link}">${path}</span>
4+
</h3>

‎fr-ca/articles/_includes/_ip_whitelist.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
::: note Network Firewall
2+
If you are behind a firewall, this feature may require [whitelisting of the appropriate Auth0 IP addresses](/guides/ip-whitelist) to work properly.
3+
:::

‎fr-ca/articles/_includes/_java_new_app.html

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<% if (account.userName) { %>
2+
<p>Fetch your credentials (Domain, Client ID, and Client Secret) from your <a href="${manage_url}/#/">dashboard</a> and store them somewhere safe. You will need them while configuring your application. The sample is configured with your `Default App` credentials if you prefer to start with having a look at it.</p>
3+
<% } else { %>
4+
<p>Create an <a href="${manage_url}/login">Auth0 account</a> (or login) and an authentication application instance from your <a href="${manage_url}/#/">dashboard</a>. Once you create an app, you'll be provided with credentials (Domain, Client ID, and Client Secret) which should be stored somewhere safe (do not commit this information to your git repo!). You can start by downloading the sample after you login as it is configured with your Default App credentials</p>
5+
<% } %>
6+
<p> Make sure that your Auth0 Application has one or more connections configured, for example, Google Social Connection, or username-password DB connection.
7+
</p>

‎fr-ca/articles/_includes/_libraries_support_frameworks.html

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
<table class="table">
2+
<thead>
3+
<tr>
4+
<th width="25%">SDK</th>
5+
<th width="55%">Version</th>
6+
<th width="20%">Level of Support</th>
7+
</tr>
8+
</thead>
9+
<tbody>
10+
<tr>
11+
<td><a href="https://github.com/auth0/angular-auth0">Angular Auth0</a></td>
12+
<td>v2</td>
13+
<td><div class="label label-primary">Supported</div></td>
14+
</tr>
15+
<tr>
16+
<td><a href="https://github.com/auth0/angular-lock">Angular Lock</a></td>
17+
<td>v2</td>
18+
<td><div class="label label-primary">Supported</div></td>
19+
</tr>
20+
<tr>
21+
<td><a href="https://github.com/auth0/auth0-servlet">Auth0 Servlet</a></td>
22+
<td>v3</td>
23+
<td><div class="label label-primary">Supported</div></td>
24+
</tr>
25+
<tr>
26+
<td><a href="https://github.com/auth0/auth0-java-mvc-common/">Auth0 Java MVC Common</a></td>
27+
<td>v1</td>
28+
<td><div class="label label-primary">Supported</div></td>
29+
</tr>
30+
<tr>
31+
<td><a href="https://github.com/auth0/auth0-oidc-client-net">OIDC Client for .NET Desktop and Mobile applications</a></td>
32+
<td>v1</td>
33+
<td><div class="label label-primary">Supported</div></td>
34+
</tr>
35+
<tr>
36+
<td><a href="https://github.com/auth0/jwt-auth-bundle">JWT Auth Bundle</a></td>
37+
<td>v3</td>
38+
<td><div class="label label-default">Supported</div></td>
39+
</tr>
40+
</tbody>
41+
</table>

‎fr-ca/articles/_includes/_libraries_support_lock.html

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
<table class="table">
2+
<thead>
3+
<tr>
4+
<th width="25%">Library</th>
5+
<th width="55%">Version</th>
6+
<th width="20%">Level of Support</th>
7+
</tr>
8+
</thead>
9+
<tbody>
10+
<tr>
11+
<td><a href="https://github.com/auth0/lock">Lock.js</a></td>
12+
<td>v11</td>
13+
<td><div class="label label-primary">Supported</div></td>
14+
</tr>
15+
<tr>
16+
<td><a href="https://github.com/auth0/Lock.Android">Lock.Android</a></td>
17+
<td>v2</td>
18+
<td><div class="label label-primary">Supported</div></td>
19+
</tr>
20+
<tr class="light-top-border">
21+
<td><a href="https://github.com/auth0/Lock.Android/tree/v1">Lock.Android</a></td>
22+
<td>v1</td>
23+
<td><div class="label label-warning">Bug fixes</div></td>
24+
</tr>
25+
<tr>
26+
<td><a href="https://github.com/auth0/Lock.swift">Lock for iOS v2</a></td>
27+
<td>v2</td>
28+
<td><div class="label label-primary">Supported</div></td>
29+
</tr>
30+
<tr class="light-top-border">
31+
<td><a href="https://github.com/auth0/Lock.swift/tree/v1">Lock for iOS v1</a></td>
32+
<td>v1</td>
33+
<td><div class="label label-warning">Bug fixes</div></td>
34+
</tr>
35+
</tbody>
36+
</table>

‎fr-ca/articles/_includes/_libraries_support_sdks.html

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
<table class="table">
2+
<thead>
3+
<tr>
4+
<th width="25%">SDK</th>
5+
<th width="55%">Version</th>
6+
<th width="20%">Level of Support</th>
7+
</tr>
8+
</thead>
9+
<tbody>
10+
<tr>
11+
<td><a href="https://github.com/auth0/auth0-spa-js">Auth0 Single Page Application SDK</a></td>
12+
<td>v1</td>
13+
<td><div class="label label-primary">Supported</div></td>
14+
</tr>
15+
<tr>
16+
<td><a href="https://github.com/auth0/auth0-react">Auth0 React SDK</a></td>
17+
<td>v1</td>
18+
<td><div class="label label-primary">Supported</div></td>
19+
</tr>
20+
<tr>
21+
<td><a href="https://github.com/auth0/auth0.js">Auth0.js</a></td>
22+
<td>v9</td>
23+
<td><div class="label label-primary">Supported</div></td>
24+
</tr>
25+
<tr>
26+
<td><a href="https://github.com/auth0/Auth0.Android">Auth0 Android</a></td>
27+
<td>v1</td>
28+
<td><div class="label label-primary">Supported</div></td>
29+
</tr>
30+
<tr>
31+
<td><a href="https://github.com/auth0/Auth0.Swift">Auth0 Swift</a></td>
32+
<td>v1</td>
33+
<td><div class="label label-primary">Supported</div></td>
34+
</tr>
35+
<tr>
36+
<td><a href="https://github.com/auth0/Auth0.net">Auth0 .NET</a></td>
37+
<td>v4</td>
38+
<td><div class="label label-primary">Supported</div></td>
39+
</tr>
40+
<tr>
41+
<td><a href="https://github.com/auth0/Auth0-java">Auth0 Java</a></td>
42+
<td>v1</td>
43+
<td><div class="label label-primary">Supported</div></td>
44+
</tr>
45+
<tr>
46+
<td><a href="https://github.com/auth0/node-auth0">Auth0 Node</a></td>
47+
<td>v2</td>
48+
<td><div class="label label-primary">Supported</div></td>
49+
</tr>
50+
<tr>
51+
<td><a href="https://github.com/auth0/auth0-python">Auth0 Python</a></td>
52+
<td>v2</td>
53+
<td><div class="label label-primary">Supported</div></td>
54+
</tr>
55+
<tr>
56+
<td><a href="https://github.com/auth0/auth0-php">Auth0 PHP</a></td>
57+
<td>v7.3</td>
58+
<td><div class="label label-primary">Supported</div></td>
59+
</tr>
60+
</tbody>
61+
</table>

‎fr-ca/articles/_includes/_linking_accounts.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
There may be situations when your users want to log in with multiple accounts that they own. In these cases, you may want to link these accounts together so that they are all reflected in the user's Auth0 profile. For example, if a user has signed up with an email and password (which provides very little information about them), you can ask them to link their account to an OAuth provider like Facebook or Google to gain access to their social profile. See [User Account Linking](/users/concepts/overview-user-account-linking) for details.
2+
3+
## Linking Accounts
4+
5+
To link accounts, call the [link a user account](/api/management/v2#!/Users/post_identities) endpoint. You will need the ID Token and `user_id` of the primary account and the ID Token of the secondary account.
6+
7+
To differentiate the login from the linking login, you will need to create a second instance of `Auth0Lock` to obtain the ID Token of the secondary account.
8+
9+
Since all instances of `Auth0Lock` will receive the `authenticated` event, you will need a way to determine if authentication came from the primary login or the linking login.
10+
11+
You can use the `auth.params` property of the [options object](https://github.com/auth0/lock#authentication-options) of `Auth0Lock` to add a `state` property with the value `'linking'`.

0 commit comments

Comments
 (0)