idp-admin 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -2
- package/docs/fake.md +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -6,7 +6,13 @@ Apps that sign people in through an identity provider (Cognito, Keycloak, Entra
|
|
|
6
6
|
|
|
7
7
|
idp-admin is that layer, written once.
|
|
8
8
|
|
|
9
|
-
> **Status:**
|
|
9
|
+
> **Status:** 0.x, so the API may still change between minor versions. The adapters are published and usable directly; `IdpAdmin`, the class that adds the shared rules on top of them (including the access-reduced hook below), isn't built yet.
|
|
10
|
+
|
|
11
|
+
```sh
|
|
12
|
+
npm install idp-admin
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
The reference for every entry point is in [docs](docs/index.md).
|
|
10
16
|
|
|
11
17
|
## Why it exists
|
|
12
18
|
|
|
@@ -37,7 +43,7 @@ This package came out of exactly that situation: two production apps, each with
|
|
|
37
43
|
|
|
38
44
|
## Providers
|
|
39
45
|
|
|
40
|
-
|
|
46
|
+
Cognito, Keycloak and the fake provider are included today: the ones we run in production and can test properly.
|
|
41
47
|
|
|
42
48
|
The interface is designed so that other providers (Entra ID, Auth0, Okta, Zitadel, Authentik and more) can be added through the same contract. Each one is contributed here and must pass the shared test suite.
|
|
43
49
|
|
package/docs/fake.md
CHANGED
|
@@ -22,7 +22,7 @@ const fake = new FakeAdapter({ attributes: ["company"] })
|
|
|
22
22
|
## Behaviour
|
|
23
23
|
|
|
24
24
|
- **Ids** are UUID v4s from `crypto.randomUUID()`.
|
|
25
|
-
- **Emails** are matched exactly.
|
|
25
|
+
- **Emails** are matched exactly. The adapter contract expects them already lowercased and trimmed, so the fake doesn't lowercase again; pass them that way when calling it directly.
|
|
26
26
|
- **Status:**
|
|
27
27
|
- a user from `createUser` or `createUserWithInvite` starts as `password_change_required`
|
|
28
28
|
- `setPassword` with `temporary: true` sets `password_change_required`, and with `temporary: false` sets `active`
|