使用 C# 调用 Keycloak Rest API

在使用 Keycloak 管理身份认证和授权方面，与其交互的 API 是一种有用的方式。使用 CURL 请求是交互的一种方式，但是我们也可以使用 C# 调用 Keycloak Rest API，在本文中我们将探讨如何使用 C# 实现。

下面是一步步的指南。

前提条件

在使用 C# 调用 Keycloak Rest API 之前，我们需要确保以下条件已满足：

• 已安装 Visual Studio 或类似的开发工具。
• 已安装 .NET 5.0 或更新的版本。

步骤1：添加依赖项

首先，我们需要使用 NuGet 包管理器将以下三个包添加到我们的项目中。

• RestSharp
• JWT
• Microsoft.Extensions.Configuration

我们使用 Configuration 包来管理我们的应用程序配置。JWT（JSON Web Token）是 Keycloak Rest API 中通用的令牌类型。RestSharp 是一个轻量级的 HTTP 客户端，基于 .NET。

markdown 代码片段：

Install-Package RestSharp
Install-Package JWT
Install-Package Microsoft.Extensions.Configuration

步骤2：创建应用程序配置

使用 Configuration 包，我们可以从 appsettings.json 配置文件中读取应用程序配置。以下是示例配置：

{
  "Keycloak": {
    "BaseUrl": "http://localhost:8080/auth",
    "Realm": "myrealm",
    "ClientId": "myclient",
    "ClientSecret": "mysecret"
  }
}

步骤3：获取 Keycloak Token

在使用 Keycloak Rest API 进行其他操作之前，必须使用有效的 Keycloak 令牌进行身份验证。以下是获取 Keycloak 令牌的 C# 代码：

using RestSharp;
using Jwt;

var configuration = new ConfigurationBuilder()
    .AddJsonFile("appsettings.json")
    .Build();

var baseUrl = configuration["Keycloak:BaseUrl"];
var realm = configuration["Keycloak:Realm"];
var clientId = configuration["Keycloak:ClientId"];
var clientSecret = configuration["Keycloak:ClientSecret"];

var client = new RestClient($"{baseUrl}/realms/{realm}/protocol/openid-connect/token");
var request = new RestRequest(Method.POST);
request.AddParameter("grant_type", "client_credentials");
request.AddParameter("client_id", clientId);
request.AddParameter("client_secret", clientSecret);
request.AddParameter("scope", "openid");

var response = client.Execute(request);
var token = JsonWebToken.Decode<Dictionary<string, object>>(response.Content)["access_token"].ToString();

以上代码中，我们从 appsettings.json 文件中读取了 Keycloak 的配置，并使用一个 HTTP POST 请求获取令牌。响应内容是包含访问令牌的 JSON 对象，我们从中取出访问令牌的值。

步骤4：调用 Keycloak API

在您的应用程序中，您可以调用任何 Keycloak Rest API 端点以获取关于 Keycloak 实例和其配置的信息。以下是示例代码，该示例代码演示了如何获取已启用身份验证的用户的列表。

var client = new RestClient($"{baseUrl}/admin/realms/{realm}/users");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", $"Bearer {token}");
request.AddHeader("Content-type", "application/json");

var response = client.Execute(request);
var users = JArray.Parse(response.Content);

以上代码执行了一个 HTTP GET 请求，请求用户列表。我们将从 appsettings 文件中引用的客户端令牌附加到头文件 Authorization 中，以使用 Keycloak Rest API 进行身份验证。

结论

使用 C# 调用 Keycloak Rest API，是与 Keycloak 通信的一种方便的方式。我们需要使用 RestSharp ， JWT 和 Microsoft.Extensions.Configuration 三个 NuGet 包。使用 Configuration 包从 appsettings.json 文件中读取 Keycloak 的配置。使用 JWT 从 Keycloak Rest API 获取令牌后，使用 RestSharp 进行调用。 以上代码可以作为示例使用和调整。