keycloak-api-manager 5.0.3 → 5.0.4

package/README.md

@@ -65,10 +65,13 @@ In Keycloak 26.x, management-permissions APIs used by group/user fine-grained te
 - `configure(credentials)`
 - `setConfig(overrides)`
 - `getToken()`
+- `login(credentials)`
 - `auth(credentials)`
 - `stop()`
 
-`auth(credentials)` is an OIDC token endpoint helper for login/token grant flows (user/client). It does not replace the internal admin session configured by `configure()`.
+`login(credentials)` is the preferred OIDC token endpoint helper for login/token grant flows (user/client).
+
+`auth(credentials)` is kept as backward-compatible alias and does not replace the internal admin session configured by `configure()`.
 
 Configured handler namespaces:
 

package/docs/api/configuration.md

@@ -7,6 +7,7 @@ Core API methods for initializing and managing the Keycloak Admin Client connect
 - [configure()](#configure)
 - [setConfig()](#setconfig)
 - [getToken()](#gettoken)
+- [login()](#login)
 - [auth()](#auth)
 - [stop()](#stop)
 
@@ -236,6 +237,23 @@ const response = await axios.get('https://keycloak.example.com/admin/realms/mast
 
 ## auth()
 
+Backward-compatible alias of `login()`.
+
+Use `login()` in new code for clearer intent.
+
+**Syntax:**
+```javascript
+await KeycloakManager.auth(credentials)
+```
+
+### Returns
+
+**Promise\<Object\>** - Same response as `login()`
+
+---
+
+## login()
+
 Request tokens from Keycloak via the OIDC token endpoint.
 
 This method is intended for application-level login/token flows (for users, service clients, or third-party integrations) using this package as a wrapper.
@@ -244,7 +262,7 @@ It does **not** reconfigure or replace the internal admin session created by `co
 
 **Syntax:**
 ```javascript
-await KeycloakManager.auth(credentials)
+await KeycloakManager.login(credentials)
 ```
 
 ### Parameters
@@ -287,7 +305,7 @@ await KeycloakManager.configure({
 });
 
 // Application login/token request for an end-user
-const tokenResponse = await KeycloakManager.auth({
+const tokenResponse = await KeycloakManager.login({
   grant_type: 'password',
   username: 'end-user',
   password: 'user-password',
@@ -300,7 +318,7 @@ console.log(tokenResponse.access_token);
 #### Client Credentials Login
 
 ```javascript
-const tokenResponse = await KeycloakManager.auth({
+const tokenResponse = await KeycloakManager.login({
   grant_type: 'client_credentials',
   client_id: 'my-public-api',
   client_secret: process.env.API_CLIENT_SECRET
@@ -312,7 +330,7 @@ console.log(tokenResponse.access_token);
 #### Refresh Token Flow
 
 ```javascript
-const refreshed = await KeycloakManager.auth({
+const refreshed = await KeycloakManager.login({
   grant_type: 'refresh_token',
   refresh_token: oldRefreshToken
 });
@@ -322,9 +340,9 @@ console.log(refreshed.access_token);
 
 ### Notes
 
-- `auth()` posts to `${baseUrl}/realms/${realmName}/protocol/openid-connect/token`.
-- `auth()` returns raw token endpoint payload and throws on non-2xx responses.
-- `auth()` does not change handler wiring, runtime config, or the internal admin refresh timer.
+- `login()` posts to `${baseUrl}/realms/${realmName}/protocol/openid-connect/token`.
+- `login()` returns raw token endpoint payload and throws on non-2xx responses.
+- `login()`/`auth()` do not change handler wiring, runtime config, or the internal admin refresh timer.
 - Runtime `clientId`/`clientSecret` are appended automatically if configured and not overridden in request payload.
 
 ---

package/docs/api-reference.md

@@ -76,7 +76,8 @@ KeycloakManager.stop();
 | `configure()` | Authentication and setup | Core |
 | `setConfig()` | Runtime configuration | Core |
 | `getToken()` | Get current access token | Core |
-| `auth()` | OIDC token grant/login endpoint wrapper | Core |
+| `login()` | Preferred OIDC token grant/login endpoint wrapper | Core |
+| `auth()` | Backward-compatible alias of `login()` | Core |
 | `stop()` | Stop token refresh timer | Core |
 | `realms` | Realm management | realmsHandler |
 | `users` | User management | usersHandler |

package/docs/architecture.md

@@ -14,10 +14,11 @@ This package exposes a single runtime (`index.js`) that initializes one Keycloak
    - Updates realm/baseUrl/request options at runtime.
    - Keeps active session/token management in place.
 
-3. `auth(credentials)`
+3. `login(credentials)`
    - Direct token endpoint call for explicit OIDC login/token flows.
    - Intended for application-level third-party authentication use-cases.
    - Does not mutate the internal admin client session established by `configure()`.
+   - `auth(credentials)` remains available as backward-compatible alias.
 
 4. `stop()`
    - Stops refresh timer for clean process termination.

package/index.js

@@ -138,7 +138,7 @@ exports.stop = function stop() {
     clearRefreshTimer();
 };
 
-exports.auth = async function auth(credentials = {}) {
+async function requestOidcToken(credentials = {}) {
     assertConfigured();
 
     const body = new URLSearchParams();
@@ -175,4 +175,12 @@ exports.auth = async function auth(credentials = {}) {
     }
 
     return payload;
+}
+
+exports.auth = async function auth(credentials = {}) {
+    return requestOidcToken(credentials);
+};
+
+exports.login = async function login(credentials = {}) {
+    return requestOidcToken(credentials);
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "keycloak-api-manager",
-  "version": "5.0.3",
+  "version": "5.0.4",
   "description": "Enhanced Node.js wrapper for Keycloak Admin REST API. Professional alternative to @keycloak/keycloak-admin-client with advanced features, bug fixes, automatic token refresh, Organizations API support, fine-grained permissions, and comprehensive resource management. Battle-tested with 113+ integration tests.",
   "main": "index.js",
   "scripts": {