c#如何使用Keycloak_c#Keycloak完整教程与代码实例

星杰同学_1685

星杰同学_1685

2026-04-05

855人浏览

原创

keycloak 官方无 c# sdk,所谓 keycloak_c# 并非 nuget 包;主流方案是使用社区库 keycloak.net 或直接调用 rest api;blazor wasm 需走标准 oidc 流程,不可直接用 keycloak.net。

c#如何使用keycloak_c#keycloak完整教程与代码实例

Keycloak 官方没有提供 C# SDK,所谓“Keycloak C# SDK”或“Keycloak\_c#”不是官方维护的库,也不在 Keycloak 项目中。你无法通过 NuGet 安装名为 Keycloak_c# 的包——它不存在。

为什么搜不到 Keycloak_c# NuGet 包?

这是一个长期存在的误解,源于早期社区有人将自己封装的 Keycloak REST API 调用代码命名为 Keycloak_c# 并上传到 GitHub(非 NuGet),但未发布到官方包源,也未持续维护。目前主流、可用、有维护的 C# 方案只有两类:

  • 直接调用 Keycloak Admin REST API(HTTP + JSON)
  • 使用第三方封装库,如 Keycloak.Net(GitHub: neurospeech/keycloak.net,NuGet 包名:Keycloak.Net)

注意:Keycloak.Net 不是 Red Hat 官方出品,但它是目前最活跃、文档较全、支持 .NET 6+ 和 Keycloak 17+ 的社区库。

如何用 Keycloak.Net 获取用户 Token(登录)?

这是最常见的起点:让 Web 或桌面应用用户通过 Keycloak 登录,并拿到 access_token。关键不是“SDK 封装多漂亮”,而是正确构造请求参数和处理响应。

示例(使用 Keycloak.Net):

var client = new KeycloakClient(new KeycloakClientConfiguration
{
    Realm = "myrealm",
    ClientId = "myclient",
    ClientSecret = "xxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    BaseUrl = "https://auth.example.com/auth"
});
<p>// 注意:LoginAsync 默认走 confidential client 的 client_credentials 流程
// 若你是 public client(如 Blazor WASM),必须用 Authorization Code Flow + PKCE
// 此时不能用 LoginAsync,得手动跳转 /protocol/openid-connect/auth</p>

容易踩的坑:

  • ClientSecret 只对 confidential 类型客户端有效;public 客户端必须禁用该字段并走前端重定向流程
  • Keycloak 20+ 默认关闭 Direct Access Grants(即密码模式),LoginAsync(username, password) 会直接失败,除非你在管理后台显式开启
  • 返回的 TokenResponse 中,AccessToken 是 JWT 字符串,需自行解析(如用 System.IdentityModel.Tokens.Jwt)验证签名和有效期

如何调用 Keycloak Admin API 管理用户(如创建、禁用)?

Admin API 需要管理员 token(bearer token),且对应 client 必须开启 Service Accounts Enabled 并分配 realm-admin 角色。

C#
C#

"避开 C# 常见错误——空陷阱、异步陷阱、LINQ 陷阱及资源泄漏。"

下载

实操建议:

  • 不要用 Keycloak.Net.AdminClient 的默认构造函数——它不自动刷新 token,过期后所有请求 401
  • 手动获取 admin token 更可控(示例用 HttpClient):
var tokenResp = await new HttpClient().PostAsJsonAsync(
    "https://auth.example.com/auth/realms/master/protocol/openid-connect/token",
    new Dictionary<string string>
    {
        ["client_id"] = "admin-cli",
        ["grant_type"] = "password",
        ["username"] = "admin",
        ["password"] = "xxx",
        ["client_secret"] = "" // admin-cli 是 public client,无 secret
    });</string>

拿到 access_token 后,再调 Admin API:

var usersResp = await http.GetAsync(
    "https://auth.example.com/auth/admin/realms/myrealm/users?username=john");

注意路径中的 /admin/realms/{realm} 是固定格式,漏掉 /admin 会 404;Keycloak 21+ 还要求 Header 带 Authorization: Bearer {token},否则 401。

Blazor WASM 能否用 Keycloak.Net?

不能直接用——因为 Keycloak.Net 内部依赖 HttpClientHandler 和服务端证书验证逻辑,在浏览器环境不可用。WASM 必须走标准 OIDC 流程:

  • 用 Microsoft.AspNetCore.Components.WebAssembly.Authentication
  • 配置 OidcProviderOptions 指向 Keycloak 的 issuer(如 https://auth.example.com/auth/realms/myrealm)
  • 确保 Keycloak client 的 Valid Redirect URIs 包含你的 WASM 应用地址(如 https://app.example.com/authentication/login-callback)

Keycloak 返回的 token 默认不含 groups 或自定义 realm roles,需要在 client scope 中绑定 realm roles mapper,并设为 “Add to ID token” 或 “Add to access token” —— 否则 ClaimsPrincipal 里查不到角色。

真正麻烦的从来不是“怎么调接口”,而是 Keycloak 后台的 client type、access type、redirect URIs、mappers、roles assignment 这些配置项之间相互耦合。一个配错,错误信息就只报 401 或 403,根本看不出哪一环断了。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

c#

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

3029

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2268

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1200

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1158

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1336

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2098

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3340

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

14975

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
C++ Core Guidelines
C++ Core Guidelines

共0课时 | 0人学习

C++ Reference
C++ Reference

共0课时 | 0人学习

C++ 官方标准说明
C++ 官方标准说明

共0课时 | 0人学习