3.9. API 参考

构造适配器的建议方法是直接传递配置：

new Keycloak({
    url: "http://keycloak-server",
    realm: "my-realm",
    clientId: "my-app"
});

new Keycloak({
    url: "http://keycloak-server",
    realm: "my-realm",
    clientId: "my-app"
});

另外，也可以将 URL 传递给包含配置的 JSON 文件：

new Keycloak("http://your-app/adapter-config.json");

new Keycloak("http://your-app/adapter-config.json");

JSON 配置文件必须包括以下字段：

{
    "auth-server-url": "https://auth.example.com",
    "realm": "my-realm",
    "resource": "my-app"
}

{
    "auth-server-url": "https://auth.example.com",
    "realm": "my-realm",
    "resource": "my-app"
}

请注意，使用 JSON 配置文件将在初始化前触发额外的请求，因此不建议提高性能。

init (options)

调用用于初始化适配器。

选项是一个对象，其中：

返回初始化完成后解析的承诺。

login (options)

重定向到登录表单，返回 Promise。

options 是一个可选对象，其中：

createLoginUrl(options)

返回包含 URL 的 Promise，以登录表单。

选项是一个可选对象，它支持与功能 登录 相同的选项。

logout (options)

重定向至注销。

选项是一个对象，其中：

createLogoutUrl(options)

返回 URL 以注销用户。

选项是一个对象，其中：

register (options)

重定向至注册表单。带有选项操作登录的快捷方式 = 'register'

选项与登录方法相同，但 'action' 设置为 'register'

createRegisterUrl(options)

返回包含 url 的 Promise 进行注册页面。带有选项操作的 createLoginUrl 的快捷方式 = 'register'

对于 createLoginUrl 方法，选项与 createLoginUrl 方法相同，但 'action' 设置为 'register'

accountManagement()

重定向到帐户控制台。

createAccountUrl(options)

将 URL 返回到帐户控制台。

选项是一个对象，其中：

hasRealmRole(role)

如果令牌具有给定的 realm 角色，则返回 true。

hasResourceRole (role, resource)

如果令牌具有资源的给定角色（如果未指定 clientId，则使用资源是可选的），则返回 true。

loadUserProfile()

加载 users 配置文件。

返回使用配置集解析的承诺。

例如：

try {
    const profile = await keycloak.loadUserProfile();
    console.log('Retrieved user profile:', profile);
} catch (error) {
    console.error('Failed to load user profile:', error);
}

try {
    const profile = await keycloak.loadUserProfile();
    console.log('Retrieved user profile:', profile);
} catch (error) {
    console.error('Failed to load user profile:', error);
}

isTokenExpired(minValidity)

如果令牌在过期前保留的时间少于 minValidity 秒，则返回 true （如果未指定 0，则返回有效）。

updateToken(minValidity)

如果令牌在 minValidity 秒内过期（如果未指定 5，则使用 minValidity 是可选的），则会刷新令牌。如果 -1 作为 minValidity 传递，则会强制刷新令牌。如果启用了会话状态，也会检查会话状态。

返回带有布尔值解析的承诺，指示令牌是否已刷新。

例如：

try {
    const refreshed = await keycloak.updateToken(5);
    console.log(refreshed ? 'Token was refreshed' : 'Token is still valid');
} catch (error) {
    console.error('Failed to refresh the token:', error);
}

try {
    const refreshed = await keycloak.updateToken(5);
    console.log(refreshed ? 'Token was refreshed' : 'Token is still valid');
} catch (error) {
    console.error('Failed to refresh the token:', error);
}

clearToken()

清除身份验证状态，包括令牌。如果应用程序检测到会话已过期，例如更新令牌失败，这很有用。

调用此操作会导致调用AuthLogout 回调监听程序。

适配器支持为特定事件设置回调监听程序。请记住，必须在调用 init （） 方法前设置它们。

例如：

keycloak.onAuthSuccess = () => console.log('Authenticated!');

keycloak.onAuthSuccess = () => console.log('Authenticated!');

可用的事件有：