Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/patkub/auth0-rule-as-action
Experimental NPM package to run an Auth0 Rule as an Action.
https://github.com/patkub/auth0-rule-as-action
auth0 auth0-actions auth0-rules
Last synced: 24 days ago
JSON representation
Experimental NPM package to run an Auth0 Rule as an Action.
- Host: GitHub
- URL: https://github.com/patkub/auth0-rule-as-action
- Owner: patkub
- License: mit
- Created: 2024-07-20T19:58:23.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-08-04T15:17:51.000Z (3 months ago)
- Last Synced: 2024-10-01T02:22:59.985Z (about 1 month ago)
- Topics: auth0, auth0-actions, auth0-rules
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/auth0-rule-as-action
- Size: 85.9 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# auth0-rule-as-action
Run an Auth0 Rule as an Action
📦 NPM: https://www.npmjs.com/package/auth0-rule-as-action
## Experimental
This is an experiment with a very small feature set.
## Example
### Add as dependency to a Post Login action
```
auth0-rule-as-action@latest
```
### Example Post Login action
```javascript
const RuleToAction = require("auth0-rule-as-action");
/**
* The Rule
*/
function accessOnWeekdaysOnly(user, context, callback) {
if (context.clientName === 'All Applications') {
const date = new Date();
const d = date.getDay();
if (d === 0 || d === 6) {
return callback(
new UnauthorizedError('This app is available during the week')
);
}
}
callback(null, user, context);
}
/**
* Handler that will be called during the execution of a PostLogin flow.
*
* @param {Event} event - Details about the user and the context in which they are logging in.
* @param {PostLoginAPI} api - Interface whose methods can be used to change the behavior of the login.
*/
exports.onExecutePostLogin = async (event, api) => {
const rule = accessOnWeekdaysOnly;
await RuleToAction.convert(event, api, rule);
};
```
## Options
Pass in custom methods for conversion process.
```javascript
await RuleToAction.convert(event, api, rule, {
// Rule callback() method
callback: RuleToAction.defaultRuleCallback,
// Maps Post-Login action Event variables to Rules Context variables
mapEventToContext: RuleToAction.mapEventToContext
});
```
## Currently supported features
- `callback` method with success and error
- ID and Access token claims
- SAML configuration mappings
```diff
-context.idToken["claim"] = "value";
+api.idToken.setCustomClaim(claim, value);
-context.accessToken["claim"] = "value";
+api.accessToken.setCustomClaim(claim, value);
-context.samlConfiguration.mappings["http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier"] = "upn";
+api.samlResponse.setAttribute("http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier", "upn");
```
## Docs
- Explanation of available [npm scripts](./docs/scripts.md).
- See [more examples](./docs/examples.md).