6.4. 使用客户端注册 CLI

无论登录方法是什么，登录的帐户都需要适当的权限才能执行客户端注册操作。请记住，非 master 域中的任何帐户都只能拥有管理同一域中客户端的权限。如果需要管理不同的域，您可以在不同的域中配置多个用户，或者在 master 域中创建一个用户，并添加角色来管理不同域中的客户端。

您不能使用 Client Registration CLI 配置用户。使用 Admin Console Web 界面或 Admin Client CLI 来配置用户。如需了解更多详细信息，请参阅 服务器管理指南。

当 kcreg 成功登录时，它会接收授权令牌并将其保存到专用配置文件中，以便令牌可用于后续调用。有关配置文件的更多信息，请参阅 第 6.4.2 节 “使用其他配置”。

有关使用客户端注册 CLI 的更多信息，请参阅内置帮助。

例如，在：

kcreg.sh help

$ kcreg.sh help

kcreg help

c:\> kcreg help

有关启动经过身份验证的会话的更多信息，请参阅 kcreg 配置凭证 --help。

默认情况下，客户端注册 CLI 会在默认位置 ./.keycloak/kcreg.config 下维护配置文件。您可以使用 --config 选项指向不同的文件或位置，以并行维护多个经过身份验证的会话。从单一线程中与单个配置文件关联的操作是最安全的方法。

您可能希望将 --no-config 选项与所有命令搭配使用，以避免将 secret 存储在配置文件中，即使它更为方便，并且需要更多令牌请求才能这样做。使用每个 kcreg 调用指定所有身份验证信息。

在 Red Hat build of Keycloak 服务器中没有配置帐户的开发人员可以使用 Client Registration CLI。只有在域管理员向开发人员发出 Initial Access Token 时，才能这样做。它是域管理员，决定如何和何时发布和分发这些令牌。域管理员可以限制 Initial Access Token 的最大年龄，以及可使用它创建的客户端总数。

开发人员有初始访问令牌后，开发人员就可以使用它来创建新客户端，而无需使用 kcreg 配置凭据进行身份验证。Initial Access Token 可以存储在配置文件中，或者指定为 kcreg create 命令的一部分。

例如，在：

kcreg.sh config initial-token $TOKEN
kcreg.sh create -s clientId=myclient

$ kcreg.sh config initial-token $TOKEN
$ kcreg.sh create -s clientId=myclient

或者

kcreg.sh create -s clientId=myclient -t $TOKEN

$ kcreg.sh create -s clientId=myclient -t $TOKEN

kcreg config initial-token %TOKEN%
kcreg create -s clientId=myclient

c:\> kcreg config initial-token %TOKEN%
c:\> kcreg create -s clientId=myclient

或者

kcreg create -s clientId=myclient -t %TOKEN%

c:\> kcreg create -s clientId=myclient -t %TOKEN%

使用 Initial Access Token 时，服务器响应包括新发布的注册访问令牌。任何后续操作都需要通过使用该令牌进行身份验证来执行，这仅对那个客户端有效。

客户端注册 CLI 会自动使用其专用配置文件来保存并使用这个令牌与其关联的客户端使用。只要同一个配置文件用于所有客户端操作，开发人员不需要进行身份验证来读取、更新或删除以这种方式创建的客户端。

有关初始访问和注册访问令牌的更多信息，请参阅客户端注册。

运行 kcreg config initial-token --help 和 kcreg config registration-token --help 命令，以了解有关如何使用客户端注册 CLI 配置令牌的更多信息。

使用凭证进行身份验证或配置 Initial Access Token 后的第一个参数通常是创建新客户端。通常，您可能希望将准备的 JSON 文件用作模板，并设置或覆盖某些属性。

以下示例演示了如何读取 JSON 文件，覆盖它可能包含的任何客户端 id，设置任何其他属性，并在成功创建后将配置输出到标准输出。

kcreg.sh create -f client-template.json -s clientId=myclient -s baseUrl=/myclient -s 'redirectUris=["/myclient/*"]' -o

$ kcreg.sh create -f client-template.json -s clientId=myclient -s baseUrl=/myclient -s 'redirectUris=["/myclient/*"]' -o

kcreg create -f client-template.json -s clientId=myclient -s baseUrl=/myclient -s "redirectUris=[\"/myclient/*\"]" -o

C:\> kcreg create -f client-template.json -s clientId=myclient -s baseUrl=/myclient -s "redirectUris=[\"/myclient/*\"]" -o

运行 kcreg create --help 以了解有关 kcreg create 命令的更多信息。

您可以使用 kcreg attrs 来列出可用的属性。请记住，许多配置属性没有检查有效或一致性。您最多指定正确的值。请记住，您的模板中不应具有任何 id 字段，不应将它们指定为 kcreg create 命令的参数。

您可以使用 kcreg get 命令检索现有客户端。

例如，在：

kcreg.sh get myclient

$ kcreg.sh get myclient

kcreg get myclient

C:\> kcreg get myclient

您还可以将客户端配置作为适配器配置文件检索，您可以使用 web 应用程序打包。

例如，在：

kcreg.sh get myclient -e install > keycloak.json

$ kcreg.sh get myclient -e install > keycloak.json

kcreg get myclient -e install > keycloak.json

C:\> kcreg get myclient -e install > keycloak.json

运行 kcreg get --help 命令以了解有关 kcreg get 命令的更多信息。

更新客户端配置的方法有两种。

其中一种方法是在获取当前配置后向服务器提交完整的新状态，将它保存到文件中、编辑它并将其发回到服务器。

例如，在：

kcreg.sh get myclient > myclient.json
vi myclient.json
kcreg.sh update myclient -f myclient.json

$ kcreg.sh get myclient > myclient.json
$ vi myclient.json
$ kcreg.sh update myclient -f myclient.json

kcreg get myclient > myclient.json
notepad myclient.json
kcreg update myclient -f myclient.json

C:\> kcreg get myclient > myclient.json
C:\> notepad myclient.json
C:\> kcreg update myclient -f myclient.json

第二种方法获取当前客户端，设置或删除它的字段，并在一个步骤中返回。

例如，在：

kcreg.sh update myclient -s enabled=false -d redirectUris

$ kcreg.sh update myclient -s enabled=false -d redirectUris

kcreg update myclient -s enabled=false -d redirectUris

C:\> kcreg update myclient -s enabled=false -d redirectUris

您还可以使用仅包含要应用的更改的文件，因此您不必将太多值指定为参数。在这种情况下，指定 --merge 告知客户端注册 CLI，而不是将 JSON 文件视为完整的新配置，应将其视为要应用到现有配置的一组属性。

例如，在：

kcreg.sh update myclient --merge -d redirectUris -f mychanges.json

$ kcreg.sh update myclient --merge -d redirectUris -f mychanges.json

kcreg update myclient --merge -d redirectUris -f mychanges.json

C:\> kcreg update myclient --merge -d redirectUris -f mychanges.json

运行 kcreg update --help 命令以了解有关 kcreg update 命令的更多信息。

使用以下示例删除客户端。

kcreg.sh delete myclient

$ kcreg.sh delete myclient

kcreg delete myclient

C:\> kcreg delete myclient

运行 kcreg delete --help 命令以了解有关 kcreg delete 命令的更多信息。

当使用 --no-config 模式执行创建、读取、更新和删除(CRUD)操作时，客户端注册 CLI 无法为您处理注册访问令牌。在这种情况下，可能会丢失对客户端最近发布的注册访问令牌的跟踪，这使得无法在该客户端上执行进一步的 CRUD 操作，而无需通过具有管理 客户端权限的账户 进行身份验证。

如果您有权限，您可以为客户端发布新的注册访问令牌，并将其输出到标准输出或保存到您选择的配置文件中。否则，您必须要求域管理员为您的客户端发布新的注册访问令牌并将其发送给您。然后，您可以通过 --token 选项将其传递给任何 CRUD 命令。您还可以使用 kcreg config registration-token 命令将新令牌保存到配置文件中，并让客户端注册 CLI 会自动为您处理它。

运行 kcreg update-token --help 命令，以了解有关 kcreg update-token 命令的更多信息。