localstack-extension-authress

LocalStack Extension for Authress Authentication and Authorization

This is the LocalStack extension that enables running authentication, user identity, permissions, api key management, and access control in your LocalStack environment via Authress.

This LocalStack extension generates a copy of the Authress API so that the authentication and access management the Authress API provides can be utilized by running services directly in any environment. You can use this to build authentication and authorization directly into your applications and services. Additionally, this extension can be used locally to develop faster without needing an Authress Account.

---

Installation

To install the Authentication & Authorization extension into LocalStack, run

localstack extensions install localstack-extension-authress

Usage

1. Start LocalStack if it isn't started already. You can do this by running:

ACTIVATE_PRO=1 LOCALSTACK_AUTH_TOKEN="LOCALSTACK_AUTH_TOKEN" EXTENSION_DEV_MODE=1 DEBUG=1 localstack start

If you run into any issues doing that, check out the Troubleshooting Guide.

The auth extension runs at http://authress.localhost.localstack.cloud:4566.

You can configure API calls to the authorization server by passing this url as the authressApiUrl or the authress_api_url depending on which SDK you are using.

import { AuthressClient } from 'authress-sdk';
const authressClient = new AuthressClient({ authressApiUrl: `http://authress.localhost.localstack.cloud:4566` });
await authressClient.userPermissions.authorizeUser(userId, resourceUri, permission);

Knowledge Base

Review the in depth guides in the Authress Local KB.

Contribution Guide

Developing for the LocalStack Authress Extension