cloudfire-auth 0.3.0 → 0.3.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 +50 -28
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -62,34 +62,56 @@ new CloudFireAuth(serviceAccountKey: ServiceAccountKey, kvNamespace?: KVNamespac
|
|
|
62
62
|
|
|
63
63
|
### Methods
|
|
64
64
|
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
|
68
|
-
|
|
|
69
|
-
|
|
|
70
|
-
|
|
|
71
|
-
|
|
|
72
|
-
|
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
|
77
|
-
|
|
|
78
|
-
|
|
|
79
|
-
|
|
|
80
|
-
|
|
|
81
|
-
|
|
|
82
|
-
|
|
|
83
|
-
|
|
|
84
|
-
|
|
|
85
|
-
|
|
|
86
|
-
|
|
|
87
|
-
|
|
|
88
|
-
|
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
|
65
|
+
#### Authentication
|
|
66
|
+
|
|
67
|
+
| Method | Status | Description |
|
|
68
|
+
| ---------------------------------------------------------------------------------- | ------ | ----------------------------------- |
|
|
69
|
+
| `verifyIdToken(idToken: string, checkRevoked?: boolean)` | ✅ | Verify Firebase ID tokens |
|
|
70
|
+
| `verifySessionCookie(sessionCookie: string, checkRevoked?: boolean)` | ✅ | Verify session cookies |
|
|
71
|
+
| `createSessionCookie(idToken: string, sessionCookieOptions: SessionCookieOptions)` | ❌ | Create session cookie from ID token |
|
|
72
|
+
| `createCustomToken(uid: string, developerClaims?: object)` | ❌ | Create custom token for client SDK |
|
|
73
|
+
|
|
74
|
+
#### User Management
|
|
75
|
+
|
|
76
|
+
| Method | Status | Description |
|
|
77
|
+
| --------------------------------------------------------------------- | ------ | -------------------------------------- |
|
|
78
|
+
| `getUser(uid: string)` | ✅ | Get user by UID |
|
|
79
|
+
| `getUserByEmail(email: string)` | ❌ | Get user by email |
|
|
80
|
+
| `getUserByPhoneNumber(phoneNumber: string)` | ❌ | Get user by phone number |
|
|
81
|
+
| `getUserByProviderUid(providerId: string, uid: string)` | ❌ | Get user by provider UID |
|
|
82
|
+
| `getUsers(identifiers: UserIdentifier[])` | ❌ | Get users by identifiers |
|
|
83
|
+
| `createUser(properties: CreateRequest)` | ❌ | Create a new user |
|
|
84
|
+
| `updateUser(uid: string, properties: UpdateRequest)` | ✅ | Update existing user |
|
|
85
|
+
| `deleteUser(uid: string)` | ✅ | Delete a user |
|
|
86
|
+
| `deleteUsers(uids: string[])` | ❌ | Delete multiple users |
|
|
87
|
+
| `listUsers(maxResults?: number, pageToken?: string)` | ❌ | List users with pagination |
|
|
88
|
+
| `importUsers(users: UserImportRecord[], options?: UserImportOptions)` | ❌ | Bulk import users with password hashes |
|
|
89
|
+
|
|
90
|
+
#### Token Management
|
|
91
|
+
|
|
92
|
+
| Method | Status | Description |
|
|
93
|
+
| -------------------------------------------------------------------- | ------ | ------------------------------------ |
|
|
94
|
+
| `revokeRefreshTokens(uid: string)` | ✅ | Revoke all refresh tokens for a user |
|
|
95
|
+
| `setCustomUserClaims(uid: string, customUserClaims: object \| null)` | ✅ | Set custom claims |
|
|
96
|
+
|
|
97
|
+
#### Email Actions
|
|
98
|
+
|
|
99
|
+
| Method | Status | Description |
|
|
100
|
+
| ------------------------------------------------------------------------------------------------------------ | ------ | --------------------------------------- |
|
|
101
|
+
| `generatePasswordResetLink(email: string, actionCodeSettings?: ActionCodeSettings)` | ❌ | Generate password reset link |
|
|
102
|
+
| `generateEmailVerificationLink(email: string, actionCodeSettings?: ActionCodeSettings)` | ❌ | Generate email verification link |
|
|
103
|
+
| `generateVerifyAndChangeEmailLink(email: string, newEmail: string, actionCodeSettings?: ActionCodeSettings)` | ❌ | Generate email change verification link |
|
|
104
|
+
| `generateSignInWithEmailLink(email: string, actionCodeSettings: ActionCodeSettings)` | ❌ | Generate sign-in with email link |
|
|
105
|
+
|
|
106
|
+
#### Provider Configuration
|
|
107
|
+
|
|
108
|
+
| Method | Status | Description |
|
|
109
|
+
| ------------------------------------------------------------------------------------ | ------ | -------------------------------------- |
|
|
110
|
+
| `listProviderConfigs(options: AuthProviderConfigFilter)` | ❌ | List SAML/OIDC provider configurations |
|
|
111
|
+
| `getProviderConfig(providerId: string)` | ❌ | Get provider configuration by ID |
|
|
112
|
+
| `createProviderConfig(config: AuthProviderConfig)` | ❌ | Create new provider configuration |
|
|
113
|
+
| `updateProviderConfig(providerId: string, updatedConfig: UpdateAuthProviderRequest)` | ❌ | Update provider configuration |
|
|
114
|
+
| `deleteProviderConfig(providerId: string)` | ❌ | Delete provider configuration |
|
|
93
115
|
|
|
94
116
|
## Environment Setup
|
|
95
117
|
|