pg-iam

A generic database backend for use in IAM APIs.

Features

• create persons, users, and groups with optional expiry dates, and activation states
• add users and/or groups to groups, specify temporal constraints on memberships
• add persons without users to groups, for external account access control management
• allow groups to moderate memberships of other groups
• affiliate groups with one another
• create capabilities, criteria for obtaining them, use them in access tokens
• specify the scope of the capabilities
• create organisational units and hierarchies with institutions, and projects
• affiliate groups with institutions and projects
• data integrity and consistency, immutable columns wherever possible
• audit log on all inserts, updates, and deletes
• SQL functions for simplified application development

Usage

Read the guide on how to install and run tests.

git clone [email protected]:unioslo/pg-iam.git
cd pg-iam
./install.sh --guide

Container

In this repository there is an extension of the docker.io/postgres image provided for running pg-iam in a container.

Warning

pg-iam will only be installed by this container when started with an empty PostgreSQL data directory during the first-time run.

Running the container

An example invocation, setting superuser password to mypassword while making PostgreSQL reachable for local connections on TCP port 5432:

docker run --rm \
    --env POSTGRES_PASSWORD=mypassword \
    -p 127.0.0.1:5432:5432 \
    ghcr.io/unioslo/pg-iam:2.9

Important

The POSTGRES_PASSWORD environment variable can be set to anything, but some value is required to start the container image. This will be used as the superuser's password.

For persisting data, you will need to mount a volume for the container's PostgreSQL data directory:

docker run --rm \
    --env POSTGRES_PASSWORD=anotherpassword \
    -v /custom/mount:/var/lib/postgresql/data \
    -p 127.0.0.1:5432:5432 \
    ghcr.io/unioslo/pg-iam:2.5

Tip

To review all available options, please refer to the docker.io/postgres images' documentation.

Learn more

Read the docs.

LICENSE

BSD.