# idp-pw-api

idp-pw-api is a backend REST API for managing user passwords in a self-hosted SAML (Security Assertion Markup Language) Identity Provider. It is open source and self-hosted, installable on Docker Hub.

Canonical page: https://ourlocalhost.com/app/6614/idp-pw-api

## Description

idp-pw-api is a backend REST API for managing user passwords in a self-hosted SAML (Security Assertion Markup Language) Identity Provider. It exposes endpoints that let end users securely reset or change their login credentials, and it is aimed at homelabbers who run their own SAML-based identity provider and want a lightweight, self-service password management service instead of a full authentication portal.

## Platform availability

Available on 0 of 10 platforms.

## Health score

56/100 (Fair), based on 3 of 4 factors.
- Maintained: 100 (last commit 4 days ago)
- Popular: 10 (2 GitHub stars)
- Easy to install: 25 (0 install platforms, install notes, Docker image)

## Links

- GitHub: https://github.com/silinternational/idp-pw-api
- Docker Hub: https://hub.docker.com/r/silintl/idp-pw-api

## Common questions

### How do I create the local environment file for idp-pw-api?

Copy local.env.dist to local.env and update the values before running the stack.

### How do I make the example local API host work?

Add an entry in /etc/hosts that maps idp-pw-api.local to 127.0.0.1.

### Why does the setup require DOCKER_UIDGID?

Set it to your uid:gid so some containers run as you and can write to your host filesystem with the file permissions owned by you.

### Which Makefile targets are used to start and remove the idp-pw-api containers?

Run make start to get the API server online and make clean to remove all containers.

---
Source: Our Local Host (https://ourlocalhost.com/app/6614/idp-pw-api), the self-hosted and open-source app directory.
