From 6d9c1a59c50d6dc1c6064466a80eb184f86918ce Mon Sep 17 00:00:00 2001 From: Josh Cunningham Date: Mon, 16 May 2022 14:47:20 -0700 Subject: [PATCH] [DXEC-763] Fix/comment parsing (#315) * fix: comment parsing return value * fix: move description to the top of the comment --- build | 18 ++++++---- .../access-on-weekdays-only-for-an-app.js | 5 ++- src/rules/active-directory-groups.js | 9 +++-- src/rules/adaptive-mfa.js | 8 ++--- src/rules/add-attributes.js | 8 ++--- src/rules/add-country.js | 8 ++--- src/rules/add-email-to-access-token.js | 7 ++-- src/rules/add-persistence-attribute.js | 6 ++-- src/rules/add-roles-from-sqlserver.js | 8 ++--- src/rules/alt-risk-score.js | 9 +++-- src/rules/appery.js | 4 +-- src/rules/arengu-policy-acceptance.js | 8 ++--- src/rules/arengu-progressive-profiling.js | 8 ++--- src/rules/aspnet-webapi.js | 8 ++--- src/rules/caisson-id-check.js | 10 +++--- ...heck-domains-against-connection-aliases.js | 9 ++--- src/rules/check-last-password-reset.js | 6 ++-- ...new-contact-add-to-contact-list-hubspot.js | 9 ++--- src/rules/creates-lead-salesforce.js | 8 ++--- src/rules/cumulio-add-metadata-to-tokens.js | 9 ++--- src/rules/default-picture-null-avatars.js | 6 ++-- src/rules/disable-resource-owner.js | 6 ++-- src/rules/disable-social-signup.js | 6 ++-- src/rules/dropbox-whitelist.js | 6 ++-- src/rules/duo-multifactor.js | 8 ++--- src/rules/email-verified.js | 8 ++--- src/rules/eva-voice-biometric.js | 9 ++--- src/rules/facebook-custom-picture.js | 6 ++-- src/rules/fraud-prevention-with-minfraud.js | 4 +-- src/rules/get-fullcontact-profile.js | 9 ++--- src/rules/get-getIP.js | 6 ++-- src/rules/get-towerdata-profile.js | 8 ++--- src/rules/get-twitter-email.js | 8 ++--- ...ian-multifactor-authorization-extension.js | 8 ++--- src/rules/guardian-multifactor-ip-range.js | 5 +-- ...rdian-multifactor-stepup-authentication.js | 8 ++--- src/rules/guardian-multifactor.js | 8 ++--- src/rules/iddataweb-verification-workflow.js | 8 ++--- src/rules/incognia-authentication.js | 9 ++--- src/rules/incognia-onboarding.js | 9 ++--- src/rules/intercom-user.js | 6 ++-- src/rules/ip-address-allowlist.js | 6 ++-- src/rules/ip-address-blocklist.js | 5 +-- src/rules/jwt.js | 6 ++-- src/rules/linkedin-original-picture.js | 6 ++-- src/rules/mailgun.js | 8 ++--- src/rules/mandrill.js | 8 ++--- src/rules/mfa-require-enrollment.js | 8 ++--- src/rules/mfa.js | 6 ++-- src/rules/migrate-root-attributes.js | 9 ++--- src/rules/mixpanel-track-event.js | 8 ++--- src/rules/mongodb.js | 6 ++-- .../mylife-digital-progressive-consent.js | 34 +++++++++---------- src/rules/netlify-role-management.js | 9 ++--- src/rules/onetrust-consent-management.js | 9 ++--- src/rules/onfido-idv.js | 11 +++--- src/rules/parse.js | 6 ++-- src/rules/pusher.js | 6 ++-- src/rules/querystring.js | 8 ++--- src/rules/remove-attributes.js | 6 ++-- src/rules/requestbin.js | 8 ++--- src/rules/require-mfa-once-per-session.js | 8 ++--- src/rules/roles-creation.js | 6 ++-- src/rules/saml-attribute-mapping.js | 8 ++--- src/rules/saml-configuration.js | 8 ++--- .../scaled-access-relationships-claim.js | 9 ++--- src/rules/seczetta-get-risk-score.js | 9 ++--- src/rules/send-events-keenio.js | 8 ++--- src/rules/send-events-segmentio.js | 8 ++--- src/rules/sendgrid.js | 9 ++--- src/rules/shopify-lead-from-login.js | 6 ++-- src/rules/signifyd-score.js | 7 ++-- src/rules/simple-domain-whitelist.js | 6 ++-- src/rules/simple-user-whitelist-for-app.js | 6 ++-- src/rules/simple-user-whitelist.js | 6 ++-- src/rules/simple-whitelist-on-a-connection.js | 6 ++-- src/rules/slack.js | 9 ++--- src/rules/soap-webservice.js | 6 ++-- src/rules/socure-fraudscore.js | 7 ++-- src/rules/splunk-HEC-track-event.js | 8 ++--- src/rules/track-consent.js | 8 ++--- src/rules/update-firebase-user.js | 8 ++--- src/rules/username-attribute.js | 9 ++--- .../verify-user-email-with-password-reset.js | 6 ++-- src/rules/vouched-verification.js | 9 ++--- src/rules/yoonik-face.js | 8 ++--- src/rules/zapier-new-login.js | 8 ++--- src/rules/zapier-new-user.js | 8 ++--- src/rules/zendesk-sso-jwt.js | 8 ++--- 89 files changed, 357 insertions(+), 344 deletions(-) diff --git a/build b/build index ea52ecc0..50dccf72 100755 --- a/build +++ b/build @@ -37,19 +37,23 @@ async.reduce(files, [], (rules, file, callback) => { // strip the opening comment and remove extra newlines const code = data.split('\n').slice(parsed.loc.end.line).join('\n').trim(); - if (argv.allRules || parsed.gallery === 'true') { - const ruleDescription = converter.makeHtml(parsed.example); + const ruleTags = {}; + parsed.tags.forEach((tag) => ruleTags[tag.title] = tag.description); + + if (argv.allRules || ruleTags.gallery === 'true') { + const ruleExample = parsed.examples.reduce((prev, curr) => "\n\n" + curr.description + "\n
" + curr.value + "
" + prev, ""); + const ruleDescription = converter.makeHtml(parsed.description + ruleExample); if (!ruleDescription) { - return callback(new Error(`Blank description for ${parsed.title}`)); + return callback(new Error(`Blank description for ${file}`)); } const rule = { id: path.basename(file).replace('.js', ''), - title: parsed.title, - overview: parsed.overview, - categories: parsed.category ? parsed.category.split(',') : ['default'], - description: converter.makeHtml(parsed.example), + title: ruleTags.title, + overview: ruleTags.overview, + categories: ruleTags.category ? ruleTags.category.split(',') : ['default'], + description: ruleDescription, code }; rules.push(rule); diff --git a/src/rules/access-on-weekdays-only-for-an-app.js b/src/rules/access-on-weekdays-only-for-an-app.js index 942c8576..00b30812 100644 --- a/src/rules/access-on-weekdays-only-for-an-app.js +++ b/src/rules/access-on-weekdays-only-for-an-app.js @@ -1,11 +1,10 @@ /** + * This rule is used to prevent access during weekends for a specific app. + * * @title Allow Access during weekdays for a specific App * @overview Prevent access to app during weekends. * @gallery true * @category access control - * - * This rule is used to prevent access during weekends for a specific app. - * */ function accessOnWeekdaysOnly(user, context, callback) { diff --git a/src/rules/active-directory-groups.js b/src/rules/active-directory-groups.js index dd343d1b..9fb82651 100644 --- a/src/rules/active-directory-groups.js +++ b/src/rules/active-directory-groups.js @@ -1,13 +1,12 @@ /** + * This rule checks if a user belongs to an AD group and if not, it will return Access Denied. + * + * > Note: you can mix this with `context.clientID` or `clientName` to do it only for specific application + * * @title Active Directory group membership * @overview Check Active Directory membership, else return Access Denied. * @gallery true * @category access control - * - * This rule checks if a user belongs to an AD group and if not, it will return Access Denied. - * - * > Note: you can mix this with `context.clientID` or `clientName` to do it only for specific application - * */ function activeDirectoryGroups(user, context, callback) { diff --git a/src/rules/adaptive-mfa.js b/src/rules/adaptive-mfa.js index 44041c14..ad6999e5 100644 --- a/src/rules/adaptive-mfa.js +++ b/src/rules/adaptive-mfa.js @@ -1,8 +1,4 @@ /** - * @title Adaptive MFA - * @overview Trigger multifactor authentication for a specific risk assessment result. - * @gallery true - * @category multifactor * * This rule is used to trigger multifactor authentication when a specific risk assessment result is detected. * @@ -10,6 +6,10 @@ * * For more information about Adaptive MFA and the `context.riskAssessment` attribute, read our [full documentation](https://auth0.com/docs/mfa/adaptive-mfa). * + * @title Adaptive MFA + * @overview Trigger multifactor authentication for a specific risk assessment result. + * @gallery true + * @category multifactor */ function adaptiveMfa(user, context, callback) { diff --git a/src/rules/add-attributes.js b/src/rules/add-attributes.js index c398fafc..ade1dca7 100644 --- a/src/rules/add-attributes.js +++ b/src/rules/add-attributes.js @@ -1,13 +1,13 @@ /** - * @title Add attributes to a user for specific connection - * @overview Add attributes to a user for specific connection. - * @gallery true - * @category enrich profile * * This rule will add an attribute to the user only for the login transaction (i.e. they won't be persisted to the user). * * This is useful for cases where you want to enrich the user information for a specific application. * + * @title Add attributes to a user for specific connection + * @overview Add attributes to a user for specific connection. + * @gallery true + * @category enrich profile */ function addAttributes(user, context, callback) { diff --git a/src/rules/add-country.js b/src/rules/add-country.js index 7878bfe1..06407007 100644 --- a/src/rules/add-country.js +++ b/src/rules/add-country.js @@ -1,8 +1,4 @@ /** - * @title Add country to the user profile - * @overview Add a country attribute to the user based on their IP address. - * @gallery true - * @category enrich profile * * This rule will add a `country` attribute to the user based on their ip address. * @@ -22,6 +18,10 @@ * } * ``` * + * @title Add country to the user profile + * @overview Add a country attribute to the user based on their IP address. + * @gallery true + * @category enrich profile */ function addCountry(user, context, callback) { diff --git a/src/rules/add-email-to-access-token.js b/src/rules/add-email-to-access-token.js index 9d718873..690b887e 100644 --- a/src/rules/add-email-to-access-token.js +++ b/src/rules/add-email-to-access-token.js @@ -1,12 +1,11 @@ /** + * + * This rule will add the authenticated user's `email` attribute value to the access token. + * * @title Add email to access token * @overview Add the authenticated user's email address to the access token. * @gallery true * @category access control - * - * This rule will add the authenticated user's `email` attribute value to the access token. - * - * */ function addEmailToAccessToken(user, context, callback) { diff --git a/src/rules/add-persistence-attribute.js b/src/rules/add-persistence-attribute.js index cfe09e67..8c18d9d1 100644 --- a/src/rules/add-persistence-attribute.js +++ b/src/rules/add-persistence-attribute.js @@ -1,11 +1,11 @@ /** + * + * This rule count set the default color (an example preference) to a user (using `user_metadata`). + * * @title Add persistent attributes to the user * @overview Set the default color of a user's `user_metadata`. * @gallery true * @category enrich profile - * - * This rule count set the default color (an example preference) to a user (using `user_metadata`). - * */ function addPersistenceAttribute(user, context, callback) { diff --git a/src/rules/add-roles-from-sqlserver.js b/src/rules/add-roles-from-sqlserver.js index 2367a23d..5961cf65 100644 --- a/src/rules/add-roles-from-sqlserver.js +++ b/src/rules/add-roles-from-sqlserver.js @@ -1,13 +1,13 @@ /** - * @title Add user roles from a SQL Server database - * @overview Query a SQL server database on each login and add a roles array to the user. - * @gallery true - * @category enrich profile * * This rule will query a SQL server database on each login and add a `roles` array to the user. * * > Note: you can store the connection string securely on Auth0 encrypted configuration. Also make sure when you call an external endpoint to open your firewall/ports to our IP address which you can find it in the rules editor. This happens when you query SQL Azure for example. * + * @title Add user roles from a SQL Server database + * @overview Query a SQL server database on each login and add a roles array to the user. + * @gallery true + * @category enrich profile */ function addRolesFromSqlServer(user, context, callback) { diff --git a/src/rules/alt-risk-score.js b/src/rules/alt-risk-score.js index 3fabd5b8..b571c78d 100644 --- a/src/rules/alt-risk-score.js +++ b/src/rules/alt-risk-score.js @@ -1,14 +1,13 @@ -/* global configuration */ /** - * @title Alternate Risk Score - * @overview Send the user's IP address, user agent, email address and username to MaxMind's MinFraud API. - * @gallery true - * @category enrich profile * * This rule will send the user's IP address, user agent, email address (in MD5) and username (in MD5) to MaxMind's MinFraud API. This API will return information about this current transaction like the location, a risk score, ... * * > Note: You will need to sign up here to get a license key https://www.maxmind.com/ * + * @title Alternate Risk Score + * @overview Send the user's IP address, user agent, email address and username to MaxMind's MinFraud API. + * @gallery true + * @category enrich profile */ // eslint-disable-next-line no-unused-vars diff --git a/src/rules/appery.js b/src/rules/appery.js index 057b6052..94ec7626 100644 --- a/src/rules/appery.js +++ b/src/rules/appery.js @@ -1,6 +1,4 @@ /** - * @title Generate an Appery.io Session Token - * @overview Generate a session token for accessing Appery.io Database Services. * * This rule is used to generate a session token for accessing [Appery.io Database Services](http://appery.io/). The rule adds a new `user.apperyio_session_token` property set to the user profile containing the Appery.io session token. You can use this `session token` to make further Appery.io API calls. * @@ -10,6 +8,8 @@ * * If the user doesn't exist, this rule will auto-provision one, with `email`, `name` or `user_id` as the handle. * + * @title Generate an Appery.io Session Token + * @overview Generate a session token for accessing Appery.io Database Services. */ function generateApperySessionToken(user, context, callback) { diff --git a/src/rules/arengu-policy-acceptance.js b/src/rules/arengu-policy-acceptance.js index 5cce0181..98dc742e 100644 --- a/src/rules/arengu-policy-acceptance.js +++ b/src/rules/arengu-policy-acceptance.js @@ -1,8 +1,4 @@ /** - * @title Arengu Policy Acceptance - * @overview Require your users to accept custom privacy policies or new terms. - * @gallery false - * @category marketplace * * Please see the [Aregnu Policy Acceptance integration](https://marketplace.auth0.com/integrations/arengu-policy-acceptance) for more information and detailed installation instructions. * @@ -11,6 +7,10 @@ * - `SESSION_TOKEN_SECRET`: A long, random string at least 32 bytes long * - `ARENGU_POLICIES_FORM_URL`: The URL that contains an [embedded form](https://github.com/arengu/forms-js-sdk#embed-a-form) or with a [hosted form page](https://www.arengu.com/pages) * + * @title Arengu Policy Acceptance + * @overview Require your users to accept custom privacy policies or new terms. + * @gallery false + * @category marketplace */ async function arenguCheckUserPolicies(user, context, callback) { diff --git a/src/rules/arengu-progressive-profiling.js b/src/rules/arengu-progressive-profiling.js index 096ab39e..bd9119ba 100644 --- a/src/rules/arengu-progressive-profiling.js +++ b/src/rules/arengu-progressive-profiling.js @@ -1,8 +1,4 @@ /** - * @title Arengu Progressive Profiling - * @overview Capture new users' information in your authentication flows. - * @gallery false - * @category marketplace * * Please see the [Aregnu Progressive Profiling integration](https://marketplace.auth0.com/integrations/arengu-progressive-profiling) for more information and detailed installation instructions. * @@ -11,6 +7,10 @@ * - `SESSION_TOKEN_SECRET`: A long, random string at least 32 bytes long * - `ARENGU_PROFILE_FORM_URL`: The URL that contains an [embedded form](https://github.com/arengu/forms-js-sdk#embed-a-form) or with a [hosted form page](https://www.arengu.com/pages) * + * @title Arengu Progressive Profiling + * @overview Capture new users' information in your authentication flows. + * @gallery false + * @category marketplace */ async function arenguCompleteUserProfile(user, context, callback) { diff --git a/src/rules/aspnet-webapi.js b/src/rules/aspnet-webapi.js index 3f782505..875a7ced 100644 --- a/src/rules/aspnet-webapi.js +++ b/src/rules/aspnet-webapi.js @@ -1,8 +1,4 @@ /** - * @title Custom webhook with ASPNET WebApi2 - * @overview Post variables sent to your Rule as a custom webhook in an ASP.NET WebApi application. - * @gallery true - * @category webhook * * This rule shows how to post the variables sent to your Rule a custom webhook in an ASP.NET WebApi application. This is useful for situations where you want to enrich the User's profile with your internal ID before the JsonWebToken is created, or if you want to seamlessly register new users. * @@ -16,6 +12,10 @@ * * Contributed by Robert McLaws, AdvancedREI.com * + * @title Custom webhook with ASPNET WebApi2 + * @overview Post variables sent to your Rule as a custom webhook in an ASP.NET WebApi application. + * @gallery true + * @category webhook */ function aspnetWebApi(user, context, callback) { diff --git a/src/rules/caisson-id-check.js b/src/rules/caisson-id-check.js index 298edb84..225bdf09 100644 --- a/src/rules/caisson-id-check.js +++ b/src/rules/caisson-id-check.js @@ -1,9 +1,4 @@ /** - * @title Caisson ID Check - * @overview Validate US driver's licenses and international passports in real time. - * @gallery false - * @category marketplace - * * Please see the [Caisson integration](https://marketplace.auth0.com/integrations/caisson-id-check) for more information and detailed installation instructions. * * **Required configuration** (this Rule will be skipped if any of the below are not defined): @@ -15,6 +10,11 @@ * **Optional configuration:** * * - `CAISSON_DEBUG` Set to "true" to log errors in the console + * + * @title Caisson ID Check + * @overview Validate US driver's licenses and international passports in real time. + * @gallery false + * @category marketplace */ async function caissonIDCheck(user, context, callback) { diff --git a/src/rules/check-domains-against-connection-aliases.js b/src/rules/check-domains-against-connection-aliases.js index ee08c20c..8cd134d0 100644 --- a/src/rules/check-domains-against-connection-aliases.js +++ b/src/rules/check-domains-against-connection-aliases.js @@ -1,14 +1,15 @@ /** - * @title Check if user email domain matches configured domain - * @overview Check user email domain matches domains configured in connection. - * @gallery true - * @category access control * * This rule checks if the user's login email matches any domains configured in an enterprise connection. If there are no matches, the login is denied. But, if there are no domains configured it will allow access. * * Use this rule to only allow users from specific email domains to login. * * For example, ExampleCo has setup exampleco.com as a managed domain. They add exampleco.com to the email domains list in their SAML connection. Now, only users with an email ending with @exampleco.com (and not @examplecocorp.com) can login via SAML. + * + * @title Check if user email domain matches configured domain + * @overview Check user email domain matches domains configured in connection. + * @gallery true + * @category access control */ function checkDomainsAgainstConnectionAliases(user, context, callback) { diff --git a/src/rules/check-last-password-reset.js b/src/rules/check-last-password-reset.js index 5c0d16ef..c61458df 100644 --- a/src/rules/check-last-password-reset.js +++ b/src/rules/check-last-password-reset.js @@ -1,11 +1,11 @@ /** + * + * This rule will check the last time that a user changed his or her account password. + * * @title Check last password reset * @overview Check the last time that a user changed his or her account password. * @gallery true * @category access control - * - * This rule will check the last time that a user changed his or her account password. - * */ function checkLastPasswordReset(user, context, callback) { diff --git a/src/rules/create-new-contact-add-to-contact-list-hubspot.js b/src/rules/create-new-contact-add-to-contact-list-hubspot.js index 4f592002..422724a0 100644 --- a/src/rules/create-new-contact-add-to-contact-list-hubspot.js +++ b/src/rules/create-new-contact-add-to-contact-list-hubspot.js @@ -1,8 +1,4 @@ /** - * @title Add New Contact to HubSpot for Marketing - * @overview Add New Contact to HubSpot then add to a List for marketing - * @gallery true - * @category webhook * * This rule will add a New Contact to HubSpot if they don't already exist, and then add that Contact to a List for marketing. * @@ -11,6 +7,11 @@ * For more details about the Rules configuration settings, see here https://auth0.com/docs/rules/guides/configuration * For more information about Hubspot API keys see here https://knowledge.hubspot.com/integrations/how-do-i-get-my-hubspot-api-key * Use 1 as the value for HUBSPOT_NEW_MEMBER_LIST_ID for the default list in Hubspot. Otherwise, you can see the ID of any list in HubSpot visiting it, and looking at the URL. It will have this format https://app.hubspot.com/contacts/:portalId/lists/:listId where :listId is the value you want. + * + * @title Add New Contact to HubSpot for Marketing + * @overview Add New Contact to HubSpot then add to a List for marketing + * @gallery true + * @category webhook */ function createNewContactAndAddToContactListHubSpot(user, context, callback) { diff --git a/src/rules/creates-lead-salesforce.js b/src/rules/creates-lead-salesforce.js index 1ba333dd..ffc78b4a 100644 --- a/src/rules/creates-lead-salesforce.js +++ b/src/rules/creates-lead-salesforce.js @@ -1,8 +1,4 @@ /** - * @title Creates a new Lead in Salesforce on First Login - * @overview On first login call the Salesforce API to record the contact as a new Lead. - * @gallery true - * @category webhook * * This rule will check if this is the first user login, and in that case will call Salesforce API to record the contact as a new Lead. It is using Salesforce REST APIs and the `resource owner` flow to obtain an `access_token`. * @@ -10,6 +6,10 @@ * * > Note: this sample implements very basic error handling. * + * @title Creates a new Lead in Salesforce on First Login + * @overview On first login call the Salesforce API to record the contact as a new Lead. + * @gallery true + * @category webhook */ function createLeadSalesforce(user, context, callback) { diff --git a/src/rules/cumulio-add-metadata-to-tokens.js b/src/rules/cumulio-add-metadata-to-tokens.js index c78d9744..d7ddfe8c 100644 --- a/src/rules/cumulio-add-metadata-to-tokens.js +++ b/src/rules/cumulio-add-metadata-to-tokens.js @@ -1,12 +1,13 @@ /** - * @title User app_metadata for Cumul.io - * @overview Add Cumul.io user app_metadata to tokens to be used for Cumul.io dashboard filtering - * @gallery false - * @category marketplace * * This integration simplifies the process of making full use of integrated Cumul.io dashboards' multi tenant features * by using Auth0 as its authentication layer. The integration will allow you to set up and use user * information in Auth0 as Cumul.io parameters to filter and structure your Cumul.io dashboards. + * + * @title User app_metadata for Cumul.io + * @overview Add Cumul.io user app_metadata to tokens to be used for Cumul.io dashboard filtering + * @gallery false + * @category marketplace */ function addMetadataToTokens(user, context, callback) { diff --git a/src/rules/default-picture-null-avatars.js b/src/rules/default-picture-null-avatars.js index 1024177d..eedbfcec 100644 --- a/src/rules/default-picture-null-avatars.js +++ b/src/rules/default-picture-null-avatars.js @@ -1,11 +1,11 @@ /** + * + * This rule will set a default picture for null avatars via a rule for email-based logins: + * * @title Default picture for null avatars * @overview Set a default picture for null avatars. * @gallery true * @category enrich profile - * - * This rule will set a default picture for null avatars via a rule for email-based logins: - * */ function defaultPictureForNullAvatars(user, context, callback) { diff --git a/src/rules/disable-resource-owner.js b/src/rules/disable-resource-owner.js index 1093ac8c..c6bac49a 100644 --- a/src/rules/disable-resource-owner.js +++ b/src/rules/disable-resource-owner.js @@ -1,11 +1,11 @@ /** + * + * This rule is used to disable the Resource Owner endpoint (to prevent users from bypassing MFA policies). + * * @title Disable the Resource Owner endpoint * @overview Disable the Resource Owner endpoint to prevent users from bypassing MFA policies. * @gallery true * @category access control - * - * This rule is used to disable the Resource Owner endpoint (to prevent users from bypassing MFA policies). - * */ function disableResourceOwner(user, context, callback) { diff --git a/src/rules/disable-social-signup.js b/src/rules/disable-social-signup.js index d0ae7f68..ea8b65a3 100644 --- a/src/rules/disable-social-signup.js +++ b/src/rules/disable-social-signup.js @@ -1,11 +1,11 @@ /** + * + * This rule is used to prevent signups using social connections. + * * @title Disable social signups * @overview Disable signups from social connections. * @gallery true * @category access control - * - * This rule is used to prevent signups using social connections. - * */ function disableSocialSignups(user, context, callback) { diff --git a/src/rules/dropbox-whitelist.js b/src/rules/dropbox-whitelist.js index b6429fd6..b737b300 100644 --- a/src/rules/dropbox-whitelist.js +++ b/src/rules/dropbox-whitelist.js @@ -1,11 +1,11 @@ /** + * + * This rule denies/grant access to users based on a list of emails stored in Dropbox. + * * @title Whitelist on the cloud * @overview Determine access to users based on a whitelist of emails stored in Dropbox. * @gallery true * @category access control - * - * This rule denies/grant access to users based on a list of emails stored in Dropbox. - * */ function dropboxWhitelist(user, context, callback) { diff --git a/src/rules/duo-multifactor.js b/src/rules/duo-multifactor.js index 11cd9e6d..5319d1db 100644 --- a/src/rules/duo-multifactor.js +++ b/src/rules/duo-multifactor.js @@ -1,8 +1,4 @@ /** - * @title Multifactor with Duo Security - * @overview Trigger multifactor authentication with Duo Security when a condition is met. - * @gallery true - * @category multifactor * * This rule is used to trigger multifactor authentication with [Duo Security](http://duosecurity.com) when a condition is met. * @@ -10,6 +6,10 @@ * * You need to create two __integrations__ in __Duo Security__: one of type __WebSDK__ and the other __Admin SDK__. * + * @title Multifactor with Duo Security + * @overview Trigger multifactor authentication with Duo Security when a condition is met. + * @gallery true + * @category multifactor */ function duoMultifactor(user, context, callback) { diff --git a/src/rules/email-verified.js b/src/rules/email-verified.js index 40aed7b7..58986102 100644 --- a/src/rules/email-verified.js +++ b/src/rules/email-verified.js @@ -1,8 +1,4 @@ /** - * @title Force email verification - * @overview Only allow access to users with verified emails. - * @gallery true - * @category access control * * This rule will only allow access users that have verified their emails. * @@ -13,6 +9,10 @@ * * If you are using [auth0.js](https://auth0.com/docs/libraries/auth0js), the equivalent option is `auto_login: false`. * + * @title Force email verification + * @overview Only allow access to users with verified emails. + * @gallery true + * @category access control */ function emailVerified(user, context, callback) { diff --git a/src/rules/eva-voice-biometric.js b/src/rules/eva-voice-biometric.js index aa76f2ea..7534baae 100644 --- a/src/rules/eva-voice-biometric.js +++ b/src/rules/eva-voice-biometric.js @@ -1,8 +1,4 @@ /** - * @title EVA Voice Biometric connector - * @overview EVA Voice Biometric connector rule for Auth0 enables voice enrolment and verification as a second factor - * @gallery false - * @category marketplace * * Please see the [EVA Voice Biometrics integration](https://marketplace.auth0.com/integrations/eva-voice-biometrics) for more information and detailed installation instructions. * @@ -18,6 +14,11 @@ * - `AURAYA_COMMON_DIGITS_PROMPT` A digit string to prompt for common digits (e.g '987654321') * - `AURAYA_PERSONAL_DIGITS_PROMPT` A string to prompt for personal digits (e.g 'your cell number') * - `AURAYA_DEBUG` Set to "true" to log errors in the console + * + * @title EVA Voice Biometric connector + * @overview EVA Voice Biometric connector rule for Auth0 enables voice enrolment and verification as a second factor + * @gallery false + * @category marketplace */ function evaVoiceBiometric(user, context, callback) { diff --git a/src/rules/facebook-custom-picture.js b/src/rules/facebook-custom-picture.js index ece27a7f..f6232833 100644 --- a/src/rules/facebook-custom-picture.js +++ b/src/rules/facebook-custom-picture.js @@ -1,11 +1,11 @@ /** + * + * This rule will set the `picture` to a custom size for users who login with Facebook. + * * @title Use a custom sized profile picture for Facebook connections * @overview Set a custom sized profile picture for Facebook connections * @gallery true * @category enrich profile - * - * This rule will set the `picture` to a custom size for users who login with Facebook. - * */ function facebookCustomPicture(user, context, callback) { diff --git a/src/rules/fraud-prevention-with-minfraud.js b/src/rules/fraud-prevention-with-minfraud.js index a2342480..b064184f 100644 --- a/src/rules/fraud-prevention-with-minfraud.js +++ b/src/rules/fraud-prevention-with-minfraud.js @@ -1,11 +1,11 @@ /** - * @title Fraud Prevention - * @overview Send the user's IP address, user agent, email address and username in MD5 to MaxMind's MinFraud API. * * This rule will send the user's IP address, user agent, email address (in MD5) and username (in MD5) to MaxMind's MinFraud API. This API will return information about this current transaction like the location, a risk score, ... * * > Note: You will need to sign up here to get a license key https://www.maxmind.com/ * + * @title Fraud Prevention + * @overview Send the user's IP address, user agent, email address and username in MD5 to MaxMind's MinFraud API. */ function fraudPrevention(user, context, callback) { diff --git a/src/rules/get-fullcontact-profile.js b/src/rules/get-fullcontact-profile.js index 45d5665a..d460c2ba 100644 --- a/src/rules/get-fullcontact-profile.js +++ b/src/rules/get-fullcontact-profile.js @@ -1,8 +1,4 @@ /** - * @title Enrich profile with FullContact - * @overview Get the user profile from FullContact using the email then add a new property to user_metadata. - * @gallery true - * @category enrich profile * * This rule gets the user profile from FullContact using the e-mail (if available). * @@ -13,6 +9,11 @@ * **Required configuration** (this Rule will be skipped if any of the below are not defined): * * - `FULLCONTACT_KEY` API key found at https://dashboard.fullcontact.com/ + * + * @title Enrich profile with FullContact + * @overview Get the user profile from FullContact using the email then add a new property to user_metadata. + * @gallery true + * @category enrich profile */ function getFullContactProfile(user, context, callback) { diff --git a/src/rules/get-getIP.js b/src/rules/get-getIP.js index 663707cf..5c7404b2 100644 --- a/src/rules/get-getIP.js +++ b/src/rules/get-getIP.js @@ -1,11 +1,11 @@ /** + * + * This rule gets the user locations based on the IP and is added to the `user_metadata` in the `geoip` attribute. + * * @title Enrich profile with the locations where the user logs in * @overview Get the user locations based on IP address and add to the app_metadata in the geoip attribute * @gallery true * @category enrich profile - * - * This rule gets the user locations based on the IP and is added to the `user_metadata` in the `geoip` attribute. - * */ function getIp(user, context, callback) { diff --git a/src/rules/get-towerdata-profile.js b/src/rules/get-towerdata-profile.js index 0efd4beb..0db03533 100644 --- a/src/rules/get-towerdata-profile.js +++ b/src/rules/get-towerdata-profile.js @@ -1,8 +1,4 @@ /** - * @title Enrich profile with Towerdata - formerly RapLeaf - * @overview Get user information from towerdata (formerly rapleaf) using email and add towerdata property to user profile. - * @gallery true - * @category enrich profile * * This rule gets user information from towerdata using the e-mail (if available). * @@ -10,6 +6,10 @@ * * See http://docs.towerdata.com/#introduction-3 for full details. * + * @title Enrich profile with Towerdata - formerly RapLeaf + * @overview Get user information from towerdata (formerly rapleaf) using email and add towerdata property to user profile. + * @gallery true + * @category enrich profile */ function getTowerdataProfile(user, context, callback) { diff --git a/src/rules/get-twitter-email.js b/src/rules/get-twitter-email.js index 420acdd4..92463510 100644 --- a/src/rules/get-twitter-email.js +++ b/src/rules/get-twitter-email.js @@ -1,8 +1,4 @@ /** - * @title Get email address from Twitter - * @overview Get user email address from Twitter. - * @gallery true - * @category enrich profile * * Get email address from Twitter * @@ -18,6 +14,10 @@ * * For example, you can save it under `app_metadata.social_email`. * + * @title Get email address from Twitter + * @overview Get user email address from Twitter. + * @gallery true + * @category enrich profile */ function getTwitterEmail(user, context, callback) { diff --git a/src/rules/guardian-multifactor-authorization-extension.js b/src/rules/guardian-multifactor-authorization-extension.js index 052c9a0b..040c90d9 100644 --- a/src/rules/guardian-multifactor-authorization-extension.js +++ b/src/rules/guardian-multifactor-authorization-extension.js @@ -1,13 +1,13 @@ /** - * @title Multifactor with Auth0 Guardian and Authorization Extension - * @overview Guardian mfa + authorization extension working together. - * @gallery true - * @category multifactor,guardian * * This rule is used to trigger multifactor authentication with Auth0 for one or more groups on the authorization extension. * * Upon first login, the user can enroll the device. * + * @title Multifactor with Auth0 Guardian and Authorization Extension + * @overview Guardian mfa + authorization extension working together. + * @gallery true + * @category multifactor,guardian */ function guardianMultifactorAuthorization(user, context, callback) { diff --git a/src/rules/guardian-multifactor-ip-range.js b/src/rules/guardian-multifactor-ip-range.js index 6ffd993d..062fad91 100644 --- a/src/rules/guardian-multifactor-ip-range.js +++ b/src/rules/guardian-multifactor-ip-range.js @@ -1,10 +1,11 @@ /** + * + * This rule is used to trigger multifactor authentication when the requesting IP is from outside the corporate IP range. + * * @title Multifactor when request comes from outside an IP range * @overview Trigger multifactor authentication when IP is outside the expected range. * @gallery true * @category multifactor,guardian - * - * This rule is used to trigger multifactor authentication when the requesting IP is from outside the corporate IP range. */ function guardianMultifactorIpRange(user, context, callback) { diff --git a/src/rules/guardian-multifactor-stepup-authentication.js b/src/rules/guardian-multifactor-stepup-authentication.js index 03a20adc..298d2638 100644 --- a/src/rules/guardian-multifactor-stepup-authentication.js +++ b/src/rules/guardian-multifactor-stepup-authentication.js @@ -1,8 +1,4 @@ /** - * @title Multifactor Stepup Authentication - * @overview Used to challenge for a second factor when requested by sending acr_values. - * @gallery true - * @category multifactor * * This rule will challenge for a second authentication factor on request (step up) when * acr_values = 'http://schemas.openid.net/pape/policies/2007/06/multi-factor' is sent in @@ -10,6 +6,10 @@ * to determine when the user has already successfully completed a challenge in the * current session. * + * @title Multifactor Stepup Authentication + * @overview Used to challenge for a second factor when requested by sending acr_values. + * @gallery true + * @category multifactor */ function guardianMultifactorStepUpAuthentication(user, context, callback) { diff --git a/src/rules/guardian-multifactor.js b/src/rules/guardian-multifactor.js index 264553d8..1609f226 100644 --- a/src/rules/guardian-multifactor.js +++ b/src/rules/guardian-multifactor.js @@ -1,13 +1,13 @@ /** - * @title Multifactor with Auth0 Guardian - * @overview Trigger multifactor authentication with Auth0 when a condition is met. - * @gallery true - * @category multifactor,guardian * * This rule is used to trigger multifactor authentication with Auth0 when a condition is met. * * Upon first login, the user can enroll the device. * + * @title Multifactor with Auth0 Guardian + * @overview Trigger multifactor authentication with Auth0 when a condition is met. + * @gallery true + * @category multifactor,guardian */ function guardianMultifactor(user, context, callback) { diff --git a/src/rules/iddataweb-verification-workflow.js b/src/rules/iddataweb-verification-workflow.js index 067fe368..f51350f7 100644 --- a/src/rules/iddataweb-verification-workflow.js +++ b/src/rules/iddataweb-verification-workflow.js @@ -1,8 +1,4 @@ /** - * @title ID DataWeb Verification Workflow - * @overview Verify your user's identity in 180+ countries with ID DataWeb's adaptive Verification Workflows. - * @gallery false - * @category marketplace * * Please see the [ID DataWeb integration](https://marketplace.auth0.com/integrations/iddataweb-identity-verification) for more information and detailed installation instructions. * @@ -16,6 +12,10 @@ * * - `IDDATAWEB_ALWAYS_VERIFY` Controls if users are verified each time they login, or just initially. We recommend "true" (verify the user on every login) for testing, not set (verify once, then not again) for production. * + * @title ID DataWeb Verification Workflow + * @overview Verify your user's identity in 180+ countries with ID DataWeb's adaptive Verification Workflows. + * @gallery false + * @category marketplace */ async function iddatawebVerificationWorkflow(user, context, callback) { diff --git a/src/rules/incognia-authentication.js b/src/rules/incognia-authentication.js index 6e3019e5..d3edab19 100644 --- a/src/rules/incognia-authentication.js +++ b/src/rules/incognia-authentication.js @@ -1,8 +1,4 @@ /** - * @title Incognia Authentication Rule - * @overview Verify if the device logging in is at a trusted location. - * @gallery false - * @category marketplace * * Please see the [Incognia Authentication integration](https://marketplace.auth0.com/integrations/incognia-authentication) for more information and detailed installation instructions. * @@ -10,6 +6,11 @@ * * - `INCOGNIA_CLIENT_ID`: The client ID obtained from Incognia's dashboard (My Apps > API Credentials) * - `INCOGNIA_CLIENT_SECRET`: The client secret obtained from Incognia's dashboard (My Apps > API Credentials) + * + * @title Incognia Authentication Rule + * @overview Verify if the device logging in is at a trusted location. + * @gallery false + * @category marketplace */ async function incogniaAuthenticationRule(user, context, callback) { diff --git a/src/rules/incognia-onboarding.js b/src/rules/incognia-onboarding.js index 58bb5f38..74335c8b 100644 --- a/src/rules/incognia-onboarding.js +++ b/src/rules/incognia-onboarding.js @@ -1,8 +1,4 @@ /** - * @title Incognia Onboarding Rule - * @overview Verify if the device location behavior matches the address declared during onboarding. - * @gallery false - * @category marketplace * * Please see the [Incognia Onboarding integration](https://marketplace.auth0.com/integrations/incognia-onboarding) for more information and detailed installation instructions. * @@ -10,6 +6,11 @@ * * - `INCOGNIA_CLIENT_ID`: The client ID obtained from Incognia's dashboard (My Apps > API Credentials) * - `INCOGNIA_CLIENT_SECRET`: The client secret obtained from Incognia's dashboard (My Apps > API Credentials) + * + * @title Incognia Onboarding Rule + * @overview Verify if the device location behavior matches the address declared during onboarding. + * @gallery false + * @category marketplace */ async function incogniaOnboardingRule(user, context, callback) { diff --git a/src/rules/intercom-user.js b/src/rules/intercom-user.js index eb9e49f5..9733b7d1 100644 --- a/src/rules/intercom-user.js +++ b/src/rules/intercom-user.js @@ -1,11 +1,11 @@ /** + * + * This rule will call the Intercom API to create a new contact or update an existing contact's activity, whenever there is a signup or login with Auth0. + * * @title Record or update an Intercom User * @overview Call the Intercom API to record/update an User. * @gallery false * @category webhook - * - * This rule will call the Intercom API to create a new contact or update an existing contact's activity, whenever there is a signup or login with Auth0. - * */ function intercomUser(user, context, callback) { diff --git a/src/rules/ip-address-allowlist.js b/src/rules/ip-address-allowlist.js index d456838e..fd82ba8a 100644 --- a/src/rules/ip-address-allowlist.js +++ b/src/rules/ip-address-allowlist.js @@ -1,11 +1,11 @@ /** + * + * This rule will only allow access to an app from a specific set of IP addresses + * * @title IP Address allowlist * @overview Only allow access to an app from a specific set of IP addresses. * @gallery true * @category access control - * - * This rule will only allow access to an app from a specific set of IP addresses - * */ function ipAddressAllowlist(user, context, callback) { diff --git a/src/rules/ip-address-blocklist.js b/src/rules/ip-address-blocklist.js index cc070e09..a38882bb 100644 --- a/src/rules/ip-address-blocklist.js +++ b/src/rules/ip-address-blocklist.js @@ -1,10 +1,11 @@ /** + * + * This rule will deny access to an app from a specific set of IP addresses. + * * @title IP Address Blocklist * @overview Do not allow access to an app from a specific set of IP addresses. * @gallery true * @category access control - * - * This rule will deny access to an app from a specific set of IP addresses. */ function ipAddressBlocklist(user, context, callback) { diff --git a/src/rules/jwt.js b/src/rules/jwt.js index 0440d02f..f7826938 100644 --- a/src/rules/jwt.js +++ b/src/rules/jwt.js @@ -1,10 +1,10 @@ /** - * @title Generate a JSON Web Token - * @overview Generate a signed JSON Web Token based on the `user` object. - * @category token * * This rule generates a signed JSON Web Token based on the `user` object. Useful when using other protocols like SAML or WS-Federation and you need to call a downstream API that accepts JSON Web Tokens. The `id_token` will be part of the user profile, which will be translated to a SAML Attribute. * + * @title Generate a JSON Web Token + * @overview Generate a signed JSON Web Token based on the `user` object. + * @category token */ function generateJwt(user, context, callback) { diff --git a/src/rules/linkedin-original-picture.js b/src/rules/linkedin-original-picture.js index 6de4dc69..d42ae27d 100644 --- a/src/rules/linkedin-original-picture.js +++ b/src/rules/linkedin-original-picture.js @@ -1,11 +1,11 @@ /** + * + * This rule will set the `picture` to the original sized profile picture for users who login with LinkedIn. + * * @title Use the original sized profile picture for LinkedIn connections * @overview Set the picture to the profile picture for users who login with LinkedIn * @gallery true * @category enrich profile - * - * This rule will set the `picture` to the original sized profile picture for users who login with LinkedIn. - * */ function useOriginallinkedInProfilePicture(user, context, callback) { diff --git a/src/rules/mailgun.js b/src/rules/mailgun.js index a9efe1d4..3012a200 100644 --- a/src/rules/mailgun.js +++ b/src/rules/mailgun.js @@ -1,13 +1,13 @@ /** - * @title Send emails through Mailgun - * @overview Send an email to an administrator on the first login of a user using Mailgun. - * @gallery true - * @category webhook * * This rule will send an email to an administrator on the first login of a user using [Mailgun](https://mailgun.com). * * We use a persistent property `SignedUp` to track whether this is the first login or subsequent ones. * + * @title Send emails through Mailgun + * @overview Send an email to an administrator on the first login of a user using Mailgun. + * @gallery true + * @category webhook */ function sendMailgunEmail(user, context, callback) { diff --git a/src/rules/mandrill.js b/src/rules/mandrill.js index cce33ef0..735831af 100644 --- a/src/rules/mandrill.js +++ b/src/rules/mandrill.js @@ -1,8 +1,4 @@ /** - * @title Send email with Mandrill - * @overview Send email with Mandrill - * @gallery true - * @category webhook * * This rule will send an email to an administrator on a user's first login. We use a persistent `signedUp` property to track whether this is the case or not. * @@ -12,6 +8,10 @@ * * Make sure to change the sender and destination emails. * + * @title Send email with Mandrill + * @overview Send email with Mandrill + * @gallery true + * @category webhook */ function sendMandrillEmail(user, context, callback) { diff --git a/src/rules/mfa-require-enrollment.js b/src/rules/mfa-require-enrollment.js index 3d4e4897..4e5c05cc 100644 --- a/src/rules/mfa-require-enrollment.js +++ b/src/rules/mfa-require-enrollment.js @@ -1,8 +1,4 @@ /** - * @title Require MFA Enrollment - * @overview Require MFA Enrollment on next login - * @gallery true - * @category multifactor * * This rule requires that any user not already enrolled in MFA will be presented with an enrollment prompt on their next login. * @@ -10,6 +6,10 @@ * * Use of the Adaptive MFA feature requires an add-on for the Enterprise plan. Please contact sales with any questions. See our [Adaptive MFA documentation](https://auth0.com/docs/mfa/adaptive-mfa) for more information. * + * @title Require MFA Enrollment + * @overview Require MFA Enrollment on next login + * @gallery true + * @category multifactor */ function requireMfaEnrollment(user, context, callback) { diff --git a/src/rules/mfa.js b/src/rules/mfa.js index 29e37619..6594d83d 100644 --- a/src/rules/mfa.js +++ b/src/rules/mfa.js @@ -1,11 +1,11 @@ /** + * + * This rule is used to trigger multifactor authentication when a condition is met. + * * @title Multifactor Authentication * @overview Trigger multifactor authentication when a condition is met. * @gallery true * @category multifactor - * - * This rule is used to trigger multifactor authentication when a condition is met. - * */ function multifactorAuthentication(user, context, callback) { diff --git a/src/rules/migrate-root-attributes.js b/src/rules/migrate-root-attributes.js index e6ed5593..24af4c37 100644 --- a/src/rules/migrate-root-attributes.js +++ b/src/rules/migrate-root-attributes.js @@ -1,8 +1,4 @@ /** - * @title Move user metadata attributes to profile root attributes - * @overview Moves select data from user_metadata to profile root attributes (family_name, given_name, name, nickname and picture). - * @gallery true - * @category enrich profile * * This rule moves select data from user_metadata to profile root attributes (family_name, given_name, name, nickname and picture). * Verify the field mapping before enabling this rule. @@ -12,6 +8,11 @@ * 1- The rule updates the profile root attribute with the mapped field from user_metadata. * 2- The mapped fields from user_metadata will be removed following the update. * 3- This rule will be executed on each login event. For signup scenarios, you should only consider using this rule if you currently use a custom signup form or Authentication Signup API, as these signup methods do not support setting the root attributes. + * + * @title Move user metadata attributes to profile root attributes + * @overview Moves select data from user_metadata to profile root attributes (family_name, given_name, name, nickname and picture). + * @gallery true + * @category enrich profile */ function migrateRootAttributes(user, context, cb) { // Field Mapping, the property is the root attribute and the value is the field name on user_metadata. diff --git a/src/rules/mixpanel-track-event.js b/src/rules/mixpanel-track-event.js index 0c0cee12..db17d3f5 100644 --- a/src/rules/mixpanel-track-event.js +++ b/src/rules/mixpanel-track-event.js @@ -1,13 +1,13 @@ /** - * @title Tracks Logins in MixPanel - * @overview Send a Sign In event to MixPanel to track logins - * @gallery true - * @category webhook * * This rule will send a `Sign In` event to MixPanel, and will include the application the user is signing in to as a property. * * See [MixPanel HTTP API](https://mixpanel.com/help/reference/http) for more information. * + * @title Tracks Logins in MixPanel + * @overview Send a Sign In event to MixPanel to track logins + * @gallery true + * @category webhook */ function trackLoginInMixPanel(user, context, callback) { diff --git a/src/rules/mongodb.js b/src/rules/mongodb.js index 3f6824ff..a43ae741 100644 --- a/src/rules/mongodb.js +++ b/src/rules/mongodb.js @@ -1,10 +1,10 @@ /** - * @title Query mongodb and enrich profile - * @overview Query mongoDB and add a property to the user. - * @category database * * This rule will query mongodb and add a property to the user. * + * @title Query mongodb and enrich profile + * @overview Query mongoDB and add a property to the user. + * @category database */ function enrichProfileWithMongo(user, context, callback) { diff --git a/src/rules/mylife-digital-progressive-consent.js b/src/rules/mylife-digital-progressive-consent.js index daec7b6f..6bddf8a3 100644 --- a/src/rules/mylife-digital-progressive-consent.js +++ b/src/rules/mylife-digital-progressive-consent.js @@ -1,21 +1,21 @@ /** -* @title Consentric Progressive Consent -* @overview Uses a widget to capture missing consents and preferences at login to boost engagement and support compliance -* @gallery false -* @category marketplace -* -* Please see the [MyLife Digital integration](https://marketplace.auth0.com/integrations/mylife-digital-progressive-consent) for more information and detailed installation instructions. - -* **Required configuration** (this Rule will be skipped if any of the below are not defined): -* -* - `CONSENTRIC_AUTH_HOST` The URL to authenticate against for your Consentric API token, like `https://sandbox-consentric.eu.auth0.com` -* - `CONSENTRIC_API_HOST` The Consentric API host URL, like `https://sandbox.consentric.io` -* - `CONSENTRIC_CLIENT_ID` The Consentric ClientId issued to you -* - `CONSENTRIC_CLIENT_SECRET` The Consentric ClientSecret issued to you -* - `CONSENTRIC_AUDIENCE` The name of the Consentric API being called, like `https://sandbox.consentric.io` -* - `CONSENTRIC_APPLICATION_ID` The Consentric ApplicationId issued to you -* - `CONSENTRIC_REDIRECT_URL` The URL of the page containing the Progressive widget -* + * + * Please see the [MyLife Digital integration](https://marketplace.auth0.com/integrations/mylife-digital-progressive-consent) for more information and detailed installation instructions. + + * **Required configuration** (this Rule will be skipped if any of the below are not defined): + * + * - `CONSENTRIC_AUTH_HOST` The URL to authenticate against for your Consentric API token, like `https://sandbox-consentric.eu.auth0.com` + * - `CONSENTRIC_API_HOST` The Consentric API host URL, like `https://sandbox.consentric.io` + * - `CONSENTRIC_CLIENT_ID` The Consentric ClientId issued to you + * - `CONSENTRIC_CLIENT_SECRET` The Consentric ClientSecret issued to you + * - `CONSENTRIC_AUDIENCE` The name of the Consentric API being called, like `https://sandbox.consentric.io` + * - `CONSENTRIC_APPLICATION_ID` The Consentric ApplicationId issued to you + * - `CONSENTRIC_REDIRECT_URL` The URL of the page containing the Progressive widget + * + * @title Consentric Progressive Consent + * @overview Uses a widget to capture missing consents and preferences at login to boost engagement and support compliance + * @gallery false + * @category marketplace */ function consentricProgressiveConsent(user, context, callback) { const axios = require('axios@0.21.1'); diff --git a/src/rules/netlify-role-management.js b/src/rules/netlify-role-management.js index fcd84d0b..ffd4faa8 100644 --- a/src/rules/netlify-role-management.js +++ b/src/rules/netlify-role-management.js @@ -1,14 +1,15 @@ /** - * @title Netlify Role Management - * @overview Adds a default role if the user doesn't have any yet and attaches roles to the ID Token. - * @gallery true - * @category marketplace * * **Optional configuration:** * * - `DEFAULT_ROLE_NAME` - name of the default role to be given to a user * - `DEFAULT_ROLE_ID` - id of the role to be given to a user * - `CUSTOM_CLAIMS_NAMESPACE` - namespace for adding custom claims to ID Token + * + * @title Netlify Role Management + * @overview Adds a default role if the user doesn't have any yet and attaches roles to the ID Token. + * @gallery true + * @category marketplace */ async function netlifyRoleManagement(user, context, callback) { diff --git a/src/rules/onetrust-consent-management.js b/src/rules/onetrust-consent-management.js index 397c46ca..8ac40d96 100644 --- a/src/rules/onetrust-consent-management.js +++ b/src/rules/onetrust-consent-management.js @@ -1,8 +1,4 @@ /** - * @title OneTrust Consent Management - * @overview Enhance Auth0 user profiles with consent, opt-ins and communication preferences data. - * @gallery false - * @category marketplace * * Please see the [OneTrust integration](https://marketplace.auth0.com/integrations/onetrust-consent-management) for more information and detailed installation instructions. * @@ -15,6 +11,11 @@ * **Optional configuration:** * * - `ONETRUST_SKIP_IF_NO_EMAIL` If set to "true" then the Rule will be skipped if there is no email address. Otherwise the Rule will fail with an error. + * + * @title OneTrust Consent Management + * @overview Enhance Auth0 user profiles with consent, opt-ins and communication preferences data. + * @gallery false + * @category marketplace */ /* global configuration */ async function oneTrustConsentManagement(user, context, callback) { diff --git a/src/rules/onfido-idv.js b/src/rules/onfido-idv.js index 5fb8ec03..e33834f4 100644 --- a/src/rules/onfido-idv.js +++ b/src/rules/onfido-idv.js @@ -1,8 +1,4 @@ /** - * @title Onfido Identity Verification - * @overview Redirect to your Onfido IDV Application for Identity Verification during login. - * @gallery true - * @category marketplace * * Please see the [Onfido integration](https://marketplace.auth0.com/integrations/onfido-identity-verification) for more information and detailed installation instructions. * @@ -13,9 +9,10 @@ * - `ONFIDO_REGION` The supported Onfido region your tenant is operating in * - `ONFIDO_ID_VERIFICATION_URL` URL to receive the redirect * - * @param {object} user - * @param {object} context - * @param {function} callback + * @title Onfido Identity Verification + * @overview Redirect to your Onfido IDV Application for Identity Verification during login. + * @gallery true + * @category marketplace */ /* global configuration */ async function onfidoIdentityVerification(user, context, callback) { diff --git a/src/rules/parse.js b/src/rules/parse.js index 18dcc175..2e267afc 100644 --- a/src/rules/parse.js +++ b/src/rules/parse.js @@ -1,7 +1,4 @@ /** - * @title Generate an Parse Session Token - * @overview Generate a session token for accessing the Parse API - * @category enrich profile * * This rule is used to generate a session token for accessing [Parse API](http://parse.com/). The rule adds a new `user.parse_session_token` property set to the user profile containing the Parse session token. You can use this `session token` to make further Parse API calls. * @@ -11,6 +8,9 @@ * * * + * @title Generate an Parse Session Token + * @overview Generate a session token for accessing the Parse API + * @category enrich profile */ function generateParseSessionToken(user, context, callback) { diff --git a/src/rules/pusher.js b/src/rules/pusher.js index ce0248e9..7e485574 100644 --- a/src/rules/pusher.js +++ b/src/rules/pusher.js @@ -1,11 +1,11 @@ /** + * + * This rule will generate a [pusher.com] token that can be used to send and receive messages from private channels. See [a complete example here](https://github.com/auth0/auth0-pusher). + * * @title Obtain a Pusher token for subscribing and publishing to private channels * @overview Obtains a Pusher token for subscribing/publishing to private channels. * @gallery true * @category webhook - * - * This rule will generate a [pusher.com] token that can be used to send and receive messages from private channels. See [a complete example here](https://github.com/auth0/auth0-pusher). - * */ function getPusherToken(user, context, callback) { diff --git a/src/rules/querystring.js b/src/rules/querystring.js index 1b45e04e..8c4015c4 100644 --- a/src/rules/querystring.js +++ b/src/rules/querystring.js @@ -1,8 +1,4 @@ /** - * @title Querystring - * @overview Show how to check for variables in the querystring - * @gallery false - * @category enrich profile * * This rule shows how to check for variables in the `querystring`. As an example, the snippet below checks if the login transaction includes a query variable called `some_querystring` with a value `whatever` and if it does, it will add an attribute to the user profile. * An example of typical authorization URL: @@ -12,6 +8,10 @@ * * > Note: this rule works with any protocols supported by Auth0. For example, WS-Fed would be something like: `https://YOURS.auth0.com/wsfed?wtrealm=YOUR_APP_REALM&whr=urn:google-oauth2&some_querystring=whatever` * + * @title Querystring + * @overview Show how to check for variables in the querystring + * @gallery false + * @category enrich profile */ function useQuerystring(user, context, callback) { diff --git a/src/rules/remove-attributes.js b/src/rules/remove-attributes.js index 3572ee0c..3fe2e9a6 100644 --- a/src/rules/remove-attributes.js +++ b/src/rules/remove-attributes.js @@ -1,11 +1,11 @@ /** + * + * Sometimes you don't need every attribute from the user. You can use a rule to delete attributes. + * * @title Remove attributes from a user * @overview Remove attributes from a user * @gallery true * @category enrich profile - * - * Sometimes you don't need every attribute from the user. You can use a rule to delete attributes. - * */ function removeUserAttribute(user, context, callback) { diff --git a/src/rules/requestbin.js b/src/rules/requestbin.js index 18518c36..286f5280 100644 --- a/src/rules/requestbin.js +++ b/src/rules/requestbin.js @@ -1,8 +1,4 @@ /** - * @title Dump rule variables to RequestBin - * @overview Shows how to post the variables sent to your Rule to RequestBin to help troubleshoot rule issues - * @gallery true - * @category debugging * * This rule shows how to post the variables sent to your Rule to [RequestBin](https://requestbin.fullcontact.com) to help troubleshoot issues with your Rules. * @@ -12,6 +8,10 @@ * * You can run this rule by itself, or paste it into an existing rule. * + * @title Dump rule variables to RequestBin + * @overview Shows how to post the variables sent to your Rule to RequestBin to help troubleshoot rule issues + * @gallery true + * @category debugging */ function sendVariablesToRequestBin(user, context, callback) { diff --git a/src/rules/require-mfa-once-per-session.js b/src/rules/require-mfa-once-per-session.js index c051f93a..8e17aed3 100644 --- a/src/rules/require-mfa-once-per-session.js +++ b/src/rules/require-mfa-once-per-session.js @@ -1,13 +1,13 @@ /** - * @title Require MFA once per session - * @overview Require multifactor authentication only once per session - * @gallery true - * @category multifactor * * This rule can be used to avoid prompting a user for multifactor authentication if they have successfully completed MFA in their current session. * * This is particularly useful when performing silent authentication (`prompt=none`) to renew short-lived access tokens in a SPA (Single Page Application) during the duration of a user's session without having to rely on setting `allowRememberBrowser` to `true`. * + * @title Require MFA once per session + * @overview Require multifactor authentication only once per session + * @gallery true + * @category multifactor */ function requireMfaOncePerSession(user, context, callback) { diff --git a/src/rules/roles-creation.js b/src/rules/roles-creation.js index fb1ea8ab..4c67bb49 100644 --- a/src/rules/roles-creation.js +++ b/src/rules/roles-creation.js @@ -1,11 +1,11 @@ /** + * + * This rule adds a Roles field to the user based on some pattern. + * * @title Set roles to a user * @overview Add a Roles field to the user based on some pattern. * @gallery true * @category access control - * - * This rule adds a Roles field to the user based on some pattern. - * */ function setRolesToUser(user, context, callback) { diff --git a/src/rules/saml-attribute-mapping.js b/src/rules/saml-attribute-mapping.js index 77de6804..4b77c618 100644 --- a/src/rules/saml-attribute-mapping.js +++ b/src/rules/saml-attribute-mapping.js @@ -1,14 +1,14 @@ /** - * @title SAML Attributes mapping - * @overview In a SAML application customize the mapping between the Auth0 user and the SAML attributes - * @gallery true - * @category enrich profile,saml * * If the application the user is logging in to is SAML (like Salesforce for instance), you can customize the mapping between the Auth0 user and the SAML attributes. * Below you can see that we are mapping `user_id` to the NameID, `email` to `http://schemas.../emailaddress`, etc. * * For more information about SAML options, see the [SAML Configuration docs](https://docs.auth0.com/saml-configuration). * + * @title SAML Attributes mapping + * @overview In a SAML application customize the mapping between the Auth0 user and the SAML attributes + * @gallery true + * @category enrich profile,saml */ function mapSamlAttributes(user, context, callback) { diff --git a/src/rules/saml-configuration.js b/src/rules/saml-configuration.js index f3c17258..341b0dfd 100644 --- a/src/rules/saml-configuration.js +++ b/src/rules/saml-configuration.js @@ -1,14 +1,14 @@ /** - * @title Change SAML configuration - * @overview Change your SAML configuration. - * @gallery true - * @category saml * * At some point you may want to add fields to your SAML Configuration. The way to do this is to add specific fields as done in the example code snippet below. * `samlConfiguration` is an object that controls the behavior of the SAML and WS-Fed endpoints. Useful for advanced claims mapping and token enrichment (only available for SAMLP and WS-Fed protocol). * * To know more about SAML configuration options check [this documentation page](https://auth0.com/docs/saml-configuration#configuration-options). * + * @title Change SAML configuration + * @overview Change your SAML configuration. + * @gallery true + * @category saml */ function changeSamlConfiguration(user, context, callback) { diff --git a/src/rules/scaled-access-relationships-claim.js b/src/rules/scaled-access-relationships-claim.js index ee37ae5e..b40bbd54 100644 --- a/src/rules/scaled-access-relationships-claim.js +++ b/src/rules/scaled-access-relationships-claim.js @@ -1,8 +1,4 @@ /** - * @title Scaled Access relationship-based claims - * @overview Adds a claim based on the relationships the subject has in Scaled Access - * @gallery false - * @category marketplace * * Please see the [Scaled Access integration](https://marketplace.auth0.com/integrations/scaled-access) for more information and detailed installation instructions. * @@ -17,6 +13,11 @@ * **Optional configuration:** * * - `SCALED_ACCESS_CUSTOMCLAIM` A namespaced ID token claim (defaults to `https://scaledaccess.com/relationships`) + * + * @title Scaled Access relationship-based claims + * @overview Adds a claim based on the relationships the subject has in Scaled Access + * @gallery false + * @category marketplace */ function scaledAccessAddRelationshipsClaim(user, context, callback) { if ( diff --git a/src/rules/seczetta-get-risk-score.js b/src/rules/seczetta-get-risk-score.js index a3f2e776..22c88eda 100644 --- a/src/rules/seczetta-get-risk-score.js +++ b/src/rules/seczetta-get-risk-score.js @@ -1,8 +1,4 @@ /** - * @title SecZetta Get Risk Score - * @overview Grab the risk score from SecZetta to use in the authentication flow - * @gallery false - * @category marketplace * * **Required configuration** (this Rule will be skipped if any of the below are not defined): * @@ -21,6 +17,11 @@ * **Helpful Hints** * * - The SecZetta API documentation is located here: `https://{{SECZETTA_BASE_URL}}/api/v1/` + * + * @title SecZetta Get Risk Score + * @overview Grab the risk score from SecZetta to use in the authentication flow + * @gallery false + * @category marketplace */ async function seczettaGrabRiskScore(user, context, callback) { if ( diff --git a/src/rules/send-events-keenio.js b/src/rules/send-events-keenio.js index 0ce8cb44..079380ff 100644 --- a/src/rules/send-events-keenio.js +++ b/src/rules/send-events-keenio.js @@ -1,8 +1,4 @@ /** - * @title Send events to Keen - * @overview Send a signup event to Keen IO, tracked by the user.signedUp property - * @gallery true - * @category webhook * * This rule is used to send a `signup` event to [Keen IO](http://keen.io) * @@ -13,6 +9,10 @@ * * ![](http://puu.sh/7k4qN.png) * + * @title Send events to Keen + * @overview Send a signup event to Keen IO, tracked by the user.signedUp property + * @gallery true + * @category webhook */ function sendEventsToKeen(user, context, callback) { diff --git a/src/rules/send-events-segmentio.js b/src/rules/send-events-segmentio.js index d43f465a..992f1dcb 100644 --- a/src/rules/send-events-segmentio.js +++ b/src/rules/send-events-segmentio.js @@ -1,8 +1,4 @@ /** - * @title Send events to Segment IO - * @overview Send events to segment.io - * @gallery false - * @category webhook * * This rule is used to send two different events to [segment.io](http://segment.io) * @@ -10,6 +6,10 @@ * * The `sendEvent` function is a simple wrapper around the [segment.io Track REST API](https://segment.io/libraries/rest-api#track) which is trivial to call using the provided `request` module. Notice we are also sending some additional contextual information: the IP address and User Agent of the user. * + * @title Send events to Segment IO + * @overview Send events to segment.io + * @gallery false + * @category webhook */ function sendEventsToSegmentIo(user, context, callback) { diff --git a/src/rules/sendgrid.js b/src/rules/sendgrid.js index acca8947..14b0776e 100644 --- a/src/rules/sendgrid.js +++ b/src/rules/sendgrid.js @@ -1,14 +1,15 @@ /** - * @title Send emails through SendGrid - * @overview Send an email to an administrator through SendGrind on the first login of a user. - * @gallery true - * @category webhook * * This rule will send an email to an administrator on the first login of a user. * * We use a persistent property `SignedUp` to track whether this is the first login or subsequent ones. * * In the same way you can use other services like [Amazon SES](http://docs.aws.amazon.com/ses/latest/APIReference/Welcome.html), [Mandrill](https://auth0.com/mandrill) and few others. + * + * @title Send emails through SendGrid + * @overview Send an email to an administrator through SendGrind on the first login of a user. + * @gallery true + * @category webhook */ function sendEmailWithSendgrid(user, context, callback) { diff --git a/src/rules/shopify-lead-from-login.js b/src/rules/shopify-lead-from-login.js index 93b29e49..0c59ed15 100644 --- a/src/rules/shopify-lead-from-login.js +++ b/src/rules/shopify-lead-from-login.js @@ -1,11 +1,11 @@ /** + * + * This rule is used to add user accounts to Shopify as user logs in + * * @title shopify-leads-from-login * @overview Add lead to Shopify at login * @gallery true * @category webhook - * - * This rule is used to add user accounts to Shopify as user logs in - * */ async function addShopifyUser(user, context, callback) { diff --git a/src/rules/signifyd-score.js b/src/rules/signifyd-score.js index f60982b1..6e3c7ba6 100644 --- a/src/rules/signifyd-score.js +++ b/src/rules/signifyd-score.js @@ -1,12 +1,11 @@ /** + * + * This rule gets the signifyd score and status from signifyd.com and stores it in app_metadata. + * * @title Detect Ecommerce Fraud Users * @overview Get the signifyd score from signfyd.com and store it on app_metadata. * @gallery true * @category enrich profile - * - * - * This rule gets the signifyd score and status from signifyd.com and stores it in app_metadata. - * */ function getSignifydScore(user, context, callback) { diff --git a/src/rules/simple-domain-whitelist.js b/src/rules/simple-domain-whitelist.js index eeaf82d9..017f171a 100644 --- a/src/rules/simple-domain-whitelist.js +++ b/src/rules/simple-domain-whitelist.js @@ -1,11 +1,11 @@ /** + * + * This rule will only allow access to users with specific email domains. + * * @title Email domain whitelist * @overview Only allow access to users with specific whitelist email domains. * @gallery true * @category access control - * - * This rule will only allow access to users with specific email domains. - * */ function emailDomainWhitelist(user, context, callback) { diff --git a/src/rules/simple-user-whitelist-for-app.js b/src/rules/simple-user-whitelist-for-app.js index 01f92ccb..0ba664d6 100644 --- a/src/rules/simple-user-whitelist-for-app.js +++ b/src/rules/simple-user-whitelist-for-app.js @@ -1,11 +1,11 @@ /** + * + * This rule will only allow access to users with specific email addresses on a specific app. + * * @title Whitelist for a Specific App * @overview Only allow access to users with whitelist email addresses on a specific app * @gallery true * @category access control - * - * This rule will only allow access to users with specific email addresses on a specific app. - * */ function userWhitelistForSpecificApp(user, context, callback) { diff --git a/src/rules/simple-user-whitelist.js b/src/rules/simple-user-whitelist.js index 72feac77..ceec9595 100644 --- a/src/rules/simple-user-whitelist.js +++ b/src/rules/simple-user-whitelist.js @@ -1,11 +1,11 @@ /** + * + * This rule will only allow access to users with specific email addresses. + * * @title Whitelist * @overview Only allow access to users with specific whitelist email addresses. * @gallery true * @category access control - * - * This rule will only allow access to users with specific email addresses. - * */ function userWhitelist(user, context, callback) { diff --git a/src/rules/simple-whitelist-on-a-connection.js b/src/rules/simple-whitelist-on-a-connection.js index cf01c750..20868966 100644 --- a/src/rules/simple-whitelist-on-a-connection.js +++ b/src/rules/simple-whitelist-on-a-connection.js @@ -1,11 +1,11 @@ /** + * + * This rule will only allow access to certain users coming from a specific connection (e.g. fitbit). + * * @title Whitelist on Specific Connection * @overview Only allow access to users coming from a whitelist on specific connection. * @gallery true * @category access control - * - * This rule will only allow access to certain users coming from a specific connection (e.g. fitbit). - * */ function whitelistForSpecificConnection(user, context, callback) { diff --git a/src/rules/slack.js b/src/rules/slack.js index 614c5782..b3bffae4 100644 --- a/src/rules/slack.js +++ b/src/rules/slack.js @@ -1,14 +1,15 @@ /** - * @title Slack Notification on User Signup - * @overview Slack notification on user signup. - * @gallery true - * @category webhook * * This rule sends a message to a Slack channel on every user signup. * * **Required configuration** (this Rule will be skipped if any of the below are not defined): * * - `SLACK_HOOK_URL` URL to the Slack hook to notify. + * + * @title Slack Notification on User Signup + * @overview Slack notification on user signup. + * @gallery true + * @category webhook */ function slackNotificationOnUserSignup(user, context, callback) { diff --git a/src/rules/soap-webservice.js b/src/rules/soap-webservice.js index b750f603..0b5045ba 100644 --- a/src/rules/soap-webservice.js +++ b/src/rules/soap-webservice.js @@ -1,11 +1,11 @@ /** + * + * This rule shows how to query a basic profile http binding SOAP web service for roles and add those to the user. + * * @title Roles from a SOAP Service * @overview Show how to query a basic profile http binding SOAP web service for roles. * @gallery true * @category enrich profile - * - * This rule shows how to query a basic profile http binding SOAP web service for roles and add those to the user. - * */ function getRolesFromSoapService(user, context, callback) { diff --git a/src/rules/socure-fraudscore.js b/src/rules/socure-fraudscore.js index 763d59fe..5d73661c 100644 --- a/src/rules/socure-fraudscore.js +++ b/src/rules/socure-fraudscore.js @@ -1,12 +1,11 @@ /** + * + * This rule gets the fraud score from socure.com and store it on app_metadata. + * * @title Detect Fraud Users * @overview Get the fraud score from socure.com and store it on app_metadata. * @gallery true * @category enrich profile - * - * - * This rule gets the fraud score from socure.com and store it on app_metadata. - * */ function getSocureFraudScore(user, context, callback) { diff --git a/src/rules/splunk-HEC-track-event.js b/src/rules/splunk-HEC-track-event.js index 2239ae03..082eac53 100644 --- a/src/rules/splunk-HEC-track-event.js +++ b/src/rules/splunk-HEC-track-event.js @@ -1,8 +1,4 @@ /** - * @title Tracks Logins and Signups with Splunk HEC - * @overview Send SignUp and Login events to Splunk's [HTTP Event Collector] (http://dev.splunk.com/view/event-collector/SP-CAAAE7F), including some contextual information of the user. - * @gallery true - * @category webhook * * This rule will send a `SignUp` & `Login` events to Splunk's HTTP Event Collector, including some contextual information of the user: the application the user is signing in, client IP address, username, etc. * @@ -17,6 +13,10 @@ * * ![](https://cdn.auth0.com/website/rules/splunk-hec-rule.png) * + * @title Tracks Logins and Signups with Splunk HEC + * @overview Send SignUp and Login events to Splunk's [HTTP Event Collector] (http://dev.splunk.com/view/event-collector/SP-CAAAE7F), including some contextual information of the user. + * @gallery true + * @category webhook */ function trackEventsWithSplunkHec(user, context, callback) { diff --git a/src/rules/track-consent.js b/src/rules/track-consent.js index 78408a4d..70295335 100644 --- a/src/rules/track-consent.js +++ b/src/rules/track-consent.js @@ -1,13 +1,13 @@ /** - * @title Track consent from Auth0 Lock - * @overview Adds metadata on when an user has accepted the terms and conditions from within Auth0's Lock. - * @gallery true - * @category enrich profile * * This rule will add two attributes to the user's metadata object on when they accepted the terms and conditions. * * This is useful for cases where you want to track an user's consent. See https://auth0.com/docs/compliance/gdpr/features-aiding-compliance/user-consent/track-consent-with-lock for more information. * + * @title Track consent from Auth0 Lock + * @overview Adds metadata on when an user has accepted the terms and conditions from within Auth0's Lock. + * @gallery true + * @category enrich profile */ function trackConsent(user, context, callback) { diff --git a/src/rules/update-firebase-user.js b/src/rules/update-firebase-user.js index e2ecb270..7e7f7963 100644 --- a/src/rules/update-firebase-user.js +++ b/src/rules/update-firebase-user.js @@ -1,8 +1,4 @@ /** - * @title Update user profile identity in Firebase - * @overview Create or update identity information for a user profile stored in Firebase using the Firebase REST API. - * @gallery true - * @category webhook * * This rule is used to create or update identity information for a user profile stored in Firebase using the Firebase REST API. The unique `user.user_id` is base64 encoded to provide a unique generated key for the user. * @@ -10,6 +6,10 @@ * * You can find more information in the Firebase API: [REST API](https://www.firebase.com/docs/rest-api.html) * + * @title Update user profile identity in Firebase + * @overview Create or update identity information for a user profile stored in Firebase using the Firebase REST API. + * @gallery true + * @category webhook */ function updateFirebaseUser(user, context, callback) { diff --git a/src/rules/username-attribute.js b/src/rules/username-attribute.js index 3db5ffe5..303e201a 100644 --- a/src/rules/username-attribute.js +++ b/src/rules/username-attribute.js @@ -1,12 +1,13 @@ /** - * @title Add Username to AppMetadata - * @overview Adds metadata on when an user first signs up or logs in. - * @gallery true - * @category enrich profile * * This rule will add one attribute to the user's metadata object on when they log in or sign up * * This is useful for cases where you want to add the username to an email using liquid syntax. + * + * @title Add Username to AppMetadata + * @overview Adds metadata on when an user first signs up or logs in. + * @gallery true + * @category enrich profile */ function usernameAttribute(user, context, callback) { diff --git a/src/rules/verify-user-email-with-password-reset.js b/src/rules/verify-user-email-with-password-reset.js index f827e3ae..bb1991f8 100644 --- a/src/rules/verify-user-email-with-password-reset.js +++ b/src/rules/verify-user-email-with-password-reset.js @@ -1,10 +1,10 @@ /** - * @title Verify user email with password reset - * @overview Verify user email with password reset. - * @gallery true * * This rule will set the user's email as verified in the next login sequence after the password is reset successfully. * + * @title Verify user email with password reset + * @overview Verify user email with password reset. + * @gallery true */ function verifyUserWithPasswordReset(user, context, callback) { diff --git a/src/rules/vouched-verification.js b/src/rules/vouched-verification.js index 3f5b8b50..5a74156a 100644 --- a/src/rules/vouched-verification.js +++ b/src/rules/vouched-verification.js @@ -1,8 +1,4 @@ /** - * @title Vouched Verification - * @overview Verify a person's identity using Vouched. - * @gallery true - * @category marketplace * * Please see the [Vouched integration](https://marketplace.auth0.com/integrations/vouched-id-verification) for more information and detailed installation instructions. * @@ -16,6 +12,11 @@ * - `VOUCHED_API_URL` Your Vouched API URL; leave blank unless instructed by your Vouched rep * - `VOUCHED_ID_TOKEN_CLAIM` Set a `https://vouchedid/is_verified` claim in the ID token with results * - `VOUCHED_VERIFICATION_OPTIONAL` Set to "true" to succeed even if verification fails + * + * @title Vouched Verification + * @overview Verify a person's identity using Vouched. + * @gallery true + * @category marketplace */ async function vouchedVerification(user, context, callback) { diff --git a/src/rules/yoonik-face.js b/src/rules/yoonik-face.js index 15fe9ad9..c6d47309 100644 --- a/src/rules/yoonik-face.js +++ b/src/rules/yoonik-face.js @@ -1,8 +1,4 @@ /** - * @title YooniK Face Authentication - * @overview Redirect to your YooniK Face Application for Face Authentication during login. - * @gallery false - * @category marketplace * * **Required configuration** (this Rule will be skipped if any of the below are not defined): * @@ -11,6 +7,10 @@ * used in the custom app in order to verify and re-sign the session token back to Auth0. * - `YOONIK_APP_URL` The URL of your custom application that receives the redirect. * + * @title YooniK Face Authentication + * @overview Redirect to your YooniK Face Application for Face Authentication during login. + * @gallery false + * @category marketplace */ async function yoonikFaceAuthentication(user, context, callback) { if (!configuration.SESSION_TOKEN_SECRET || !configuration.YOONIK_APP_URL) { diff --git a/src/rules/zapier-new-login.js b/src/rules/zapier-new-login.js index 5ff0ffff..d3f83c83 100644 --- a/src/rules/zapier-new-login.js +++ b/src/rules/zapier-new-login.js @@ -1,8 +1,4 @@ /** - * @title Trigger a Zap on Every User Login - * @overview Trigger a Zap on Every User Login to Zapier - * @gallery true - * @category webhook * * **What is Zapier?** [Zapier](http://zapier.com) is a tool for primarily non-technical users to connect together web apps. An integration between two apps is called a Zap. A Zap is made up of a Trigger and an Action. Whenever the trigger happens in one app, Zapier will automatically perform the action in another app. * @@ -10,6 +6,10 @@ * * This rule will call Zapier static hook every time a user logs in. * + * @title Trigger a Zap on Every User Login + * @overview Trigger a Zap on Every User Login to Zapier + * @gallery true + * @category webhook */ function triggerZapOnUserLogin(user, context, callback) { diff --git a/src/rules/zapier-new-user.js b/src/rules/zapier-new-user.js index 4d2e4a0d..5c25973e 100644 --- a/src/rules/zapier-new-user.js +++ b/src/rules/zapier-new-user.js @@ -1,8 +1,4 @@ /** - * @title Trigger a Zap on New Users - * @overview Trigger a Zap on every new user signup to Zapier. - * @gallery true - * @category webhook * * **What is Zapier?** [Zapier](http://zapier.com) is a tool for primarily non-technical users to connect together web apps. An integration between two apps is called a Zap. A Zap is made up of a Trigger and an Action. Whenever the trigger happens in one app, Zapier will automatically perform the action in another app. * @@ -10,6 +6,10 @@ * * This rule will call Zapier static hook every time a new user signs up. * + * @title Trigger a Zap on New Users + * @overview Trigger a Zap on every new user signup to Zapier. + * @gallery true + * @category webhook */ function triggerZapOnNewUser(user, context, callback) { diff --git a/src/rules/zendesk-sso-jwt.js b/src/rules/zendesk-sso-jwt.js index 9b90d482..9620855c 100644 --- a/src/rules/zendesk-sso-jwt.js +++ b/src/rules/zendesk-sso-jwt.js @@ -1,8 +1,4 @@ /** - * @title Zendesk SSO for users using JWT - * @overview Zendesk SSO for users using JWT. - * @gallery false - * @category access control * * The specific details for how this works can be read here: https://support.zendesk.com/hc/en-us/articles/203663816-Setting-up-single-sign-on-with-JWT-JSON-Web-Token- * @@ -10,6 +6,10 @@ * * When the user authenticates, redirect to the URL returned in the `https://example.com/zendesk_jwt_url` claim, optionally adding the `return_to` query string parameter. * + * @title Zendesk SSO for users using JWT + * @overview Zendesk SSO for users using JWT. + * @gallery false + * @category access control */ function zendeskSsoWithJwt(user, context, callback) {