aria-php/keycloak-api

用于与 Keycloak API 交互的工具

维护者

详细信息

gitlab.com/aria-php/keycloak-api

源代码

安装: 850

依赖项: 0

建议者: 0

安全: 0

星标: 0

Forks: 1

1.0.2 2022-08-25 09:06 UTC

Requires

Requires (Dev)

LGPL-3.0-or-later 22e9906b9f795888c9cf14bd6107f068913823ac

This package is auto-updated.

Last update: 2024-09-20 13:03:02 UTC

README

该仓库是用于与 Keycloak account_api 交互的初始框架。

用法

要将此包添加到您的项目中

composer require aria-php/keycloak-api

支持的功能

此 API 封装器支持以下功能：

账户 API

  • 获取用户的配置文件（通过您发送的 access_token 作为携带令牌识别）
  • 更新配置文件
  • 设置用户密码

例如：

use ARIA\KeycloakAPI\AccountAPI;

...

$api = new AccountAPI($client_id, $secret, 'master', 'http://localhost:8080');
$api->setBearer($access_token);


$profile = $api->getProfile();


// Make your updates here


$api->setProfile($profile);

身份验证

您的用户通过从 keycloak 获取用户的访问令牌，并将其作为携带令牌传递来识别。

注意：这是 access_token，而不是 id_token。

测试

为了运行单元测试，您需要设置一些环境变量

  • KEYCLOAK_USER 是您尝试连接的用户
  • KEYCLOAK_PASS 他们的密码
  • KEYCLOAK_REALM keycloak 实体（例如 "master"）
  • KEYCLOAK_CLIENT_ID keycloak 客户端 ID（例如 "account"）
  • KEYCLOAK_SECRET 客户端密钥
  • KEYCLOAK_BASEURL 基础 URL，例如 "http://localhost:8080"

您还需要为您客户端启用 "直接访问授权"。

许可证

LGPLv3 - 请参阅 LICENSE.txt 以获取详细信息。