Keycloak.Net.Core

A Fork of https://github.com/lvermeulen/Keycloak.Net with some additional patches

• allow usage of CancellationTokens
• changed ClientConfig to Dictionary<string, string>
• removed signing
• .NET 8 support only
• updated for keycloak version 25+
• added support for changing default AdminClientId which has default admin-cli value

• added support for System.Text.Json in replacement of NewtonsoftJson.

  To use different AdminClientId, use newly introduced KeyCloakOptions:

  new KeycloakClient(
  "http://keycloak.url",
  "adminUserName",
  "adminPassword",
  new KeycloakOptions(adminClientId:"admin"
  )
  );

  Older version support for using /auth path

  When creating a new KeycloakClient, use newly introduced KeycloakOptions:

  new KeycloakClient(
  "http://keycloak.url",
  "adminUserName",
  "adminPassword",
  new KeycloakOptions(prefix:"auth"
  )
  );

C# client for Keycloak 6.x

See documentation at https://www.keycloak.org/docs-api/6.0/rest-api/

Features

• [X] Attack Detection
• [X] Authentication Management
• [X] Client Attribute Certificate
• [X] Client Initial Access
• [X] Client Registration Policy
• [X] Client Role Mappings
• [X] Client Scopes
• [X] Clients
• [X] Component
• [X] Groups
• [X] Identity Providers
• [X] Key
• [X] Protocol Mappers
• [X] Realms Admin
• [X] Role Mapper
• [X] Roles
• [X] Roles (by ID)
• [X] Scope Mappings
• [X] User Storage Provider
• [X] Users
• [X] Root

Testing

In order to run the tests, all it's needed is to have a running instance of Keycloak with (preferably) the master realm credentials admin/admin (as it's currently configured in the /test/Keycloak.Net.Core.Tests/appsettings.json) and create a new realm Insurance by importing the file in /test/insurance-real-export.json, which also has its admin user with the same credentials as mentioned before.

Then it's just as easy as running the tests.

If for some reason you want to change the credentials, you need to make sure both realms have the same user and password as the tests use the same credentials for both master and Insurance realms.