keycloak admin client

• 介绍
• 如何使用
• 定制
• 支持的API
  • 攻击检测
  • 身份验证管理
  • 客户端属性证书
  • 客户初始访问
  • 客户注册政策
  • 客户角色映射
  • 客户端范围
  • 客户
  • 成分
  • 组
  • 身份提供者
  • 钥匙
  • 协议映射器
  • Realms Admin
  • 角色映射器
  • 角色
  • 角色（通过ID）
  • 范围映射
  • 用户存储提供商
  • 用户
  • 根

介绍

这是一个可以连接到没有头痛的KeyCloak Admin REST API的PHP客户端。

特征：

1. 便于使用
2. 无需获取令牌或生成它 – 它已经由客户处理
3. 无需指定基本URI以外的任何URL
4. 没有您期望的数据的编码/解码

使用KeyCloak 7.0+管理员REST API。

https://www.ke**ycloa*k.org/documentation->“管理REST API”

如何使用

1。创建新客户

 $ client = Keycloak \\ Admin \\KeycloakClient:: factory ([
    \' realm \' => \' master \' ,
    \' username \' => \' admin \' ,
    \' password \' => \' 1234 \' ,
    \' client_id \' => \' admin-cli \' ,
    \' baseUri \' => \' http://127.*0.**0.1:8180 \' ,
]);

由于版本为0.30，如果您的KeyCloak base URL以auth/开头，请将其添加到baseUri （例如http://127.*0.**0.1:8180/auth/）。 KeyCloak版本7至16的基本URL具有系统的auth/ 。在KeyCloak 17+上，这取决于您的设置。

2。使用它

 $ client -> getUsers ();

//Result
// Array of users
/*
[
     [
       \"id\" => \"39839a9b-de08-4d2c-b91a-a6ce2595b1f3\",
       \"createdTimestamp\" => 1571663375749,
       \"username\" => \"admin\",
       \"enabled\" => true,
       \"totp\" => false,
       \"emailVerified\" => false,
       \"disableableCredentialTypes\" => [
         \"password\",
       ],
       \"requiredActions\" => [],
       \"notBefore\" => 0,
       \"access\" => [
         \"manageGroupMembership\" => true,
         \"view\" => true,
         \"mapRoles\" => true,
         \"impersonate\" => true,
         \"manage\" => true,
       ],
     ],
   ]
*/

$ client -> createUser ([
    \' username \' => \' test \' ,
    \' email \' => \' test@test.com \' ,
    \' enabled \' => true ,
    \' credentials \' => [
        [
            \' type \' => \' password \' ,
            \' value \' => \' 1234 \' ,
        ],
    ],
]);

定制

支持的证书

可以通过更改KeyCloak客户端的配置来更改用于身份验证的凭据类型。

目前，支持以下凭证

• 密码凭证，默认使用
  • 使用用户帐户进行身份验证

   $ client = Keycloak \\ Admin \\KeycloakClient:: factory ([
      ...
      \' grant_type \' => \' password \' ,
      \' username \' => \' admin \' ,
      \' password \' => \' 1234 \' ,
  ]);

• 客户凭证
  • 使用客户服务帐户进行身份验证

   $ client = Keycloak \\ Admin \\KeycloakClient:: factory ([
      ...
      \' grant_type \' => \' client_credentials \' ,
      \' client_id \' => \' admin-cli \' ,
      \' client_secret \' => \' 84ab3d98-a0c3-44c7-b532-306f222ce1ff \' ,
  ]);

注射中间件

可以使用middlewares关键字在KeyCloak客户端配置中注入Guzzle Client中间件。

例如：

 use GuzzleHttp \\ Middleware ;
use Psr \\ Http \\ Message \\ RequestInterface ;

$ client = Keycloak \\ Admin \\KeycloakClient:: factory ([
    ...
    \' middlewares \' => [
        // throws exceptions when request fails
        Middleware:: httpErrors (),
        // other custom middlewares
        Middleware:: mapRequest ( function ( RequestInterface $ request ) {
            return $ request ;
        }),
    ],
]);

更改令牌的保存和存储方式

默认情况下，令牌在运行时保存。这意味着创建新客户端时未使用以前的令牌。

您可以通过实现自己的TokenStorage来自定义令牌如何存储在客户端配置中，该接口描述了如何存储和检索令牌。

 class CustomTokenStorage implements TokenStorage 
{
    public function getToken () 
    {
        // TODO
    }
    
    public function saveToken ( array $ token )
    {
        // TODO
    }
}

$ client = Keycloak \\ Admin \\KeycloakClient:: factory ([
    ...
    \' token_storage \' => new CustomTokenStorage (),
]);

自定义KeyCloak端点

可以使用custom_operations关键字在KeyCloak客户端配置中注入Guzzle Service操作。这样，您可以使用自定义扩展内置支持的端点。

 $ client = KeycloakClient:: factory ([
...
    \' custom_operations \' => [
        \' getUsersByAttribute \' => [
            \' uri \' => \' /auth/realms/{realm}/userapi-rest/users/search-by-attr \' ,
            \' description \' => \' Get users by attribute Returns a list of users, filtered according to query parameters \' ,
            \' httpMethod \' => \' GET \' ,
            \' parameters \' => [
                \' realm \' => [
                    \' location \' => \' uri \' ,
                    \' description \' => \' The Realm name \' ,
                    \' type \' => \' string \' ,
                    \' required \' => true ,
                ],
                \' attr \' => [
                    \' location \' => \' query \' ,
                    \' type \' => \' string \' ,
                    \' required \' => true ,
                ],
                \' value \' => [
                    \' location \' => \' query \' ,
                    \' type \' => \' string \' ,
                    \' required \' => true ,
                ],
            ],
        ],
    ]
]);

支持的API

攻击检测

身份验证管理

客户端属性证书

客户初始访问

客户注册政策

客户角色映射

客户端范围

客户

成分

组

身份提供者

钥匙

协议映射器

注意：ID是作为clientscopeid或clientId和mapperid发送的，其他所有内容都像KeyCloak文档

Realms Admin

角色映射器

角色

角色（通过ID）

范围映射

用户存储提供商

用户

根