Solid.KeycloakClient 2.0.12

Keycloak - the C# library for the Keycloak Admin REST API

This is a REST API reference for the Keycloak Admin REST API.

Command used to generate the API

The OpenAPI spec at api/openapi.yaml is the official Keycloak admin spec downloaded from https://www.keycloak.org/docs-api/<version>/rest-api/openapi.yaml. The Keycloak project's spec omits operationIds, so generated method names are derived from URL paths (e.g. AdminRealmsRealmGroupsGetAsync). Notes on flags:

• library=restsharp keeps the older RestSharp/ApiClient.cs architecture. v7.11+ defaults changed to generichost (DI/HttpClient), which is incompatible with our consumers.
• --user avoids root-owned output files inside the volume mount.
• -o /local (not /local/src) places Keycloak.sln at the repo root and src/Keycloak/... one level down, matching the existing layout.

# Refresh the spec from upstream:
curl -fsSL "https://www.keycloak.org/docs-api/26.3.3/rest-api/openapi.yaml" -o api/openapi.yaml

# Regenerate:
docker run --rm -v ".:/local" --user "$(id -u):$(id -g)" \
  openapitools/openapi-generator-cli:v7.13.0 generate \
    -i /local/api/openapi.yaml \
    -g csharp \
    -o /local \
    --skip-validate-spec \
    --package-name Keycloak \
    --additional-properties=useNullableReferenceTypes=true,targetFramework=net9.0,library=restsharp \
    --type-mappings OasAnyTypeNotMapped=object

After regeneration, two hand-edits must be reapplied:

1. src/Keycloak/Model/GroupRepresentation.cs — parameterless constructor for JSON deserialization.
2. src/Keycloak/Client/ApiClient.cs — cached RestClient to prevent socket exhaustion under load.

(A third historical hand-edit in src/Keycloak/Api/ClientRoleMappingsApi.cs to wrap a single RoleRepresentation in an array is no longer needed: KC 26.3 spec correctly types the body as List<RoleRepresentation>.)

This C# SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0
• SDK version: 1.0.0
• Build package: org.openapitools.codegen.languages.CSharpClientCodegen For more information, please visit https://www.keycloak.org/documentation

<a id="frameworks-supported"></a>

Frameworks supported

<a id="dependencies"></a>

Dependencies

• RestSharp - 106.13.0 or later
• Json.NET - 13.0.2 or later
• JsonSubTypes - 1.8.0 or later
• System.ComponentModel.Annotations - 5.0.0 or later

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742. NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See RestSharp#1406.

<a id="installation"></a>

Installation

Install via NuGet:

dotnet add package Solid.KeycloakClient

Or via the Package Manager Console:

Install-Package Solid.KeycloakClient

Then use the namespaces:

using Keycloak.Api;
using Keycloak.Client;
using Keycloak.Model;

<a id="packaging"></a>

Packaging

This package is automatically built and published to NuGet via GitHub Actions on every push to main.

<a id="usage"></a>

Usage

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

<a id="getting-started"></a>

Getting Started

using System.Collections.Generic;
using System.Diagnostics;
using Keycloak.Api;
using Keycloak.Client;
using Keycloak.Model;

namespace Example
{
    public class Example
    {
        public static void Main()
        {

            Configuration config = new Configuration();
            config.BasePath = "https://keycloak.example.com/admin/realms";
            // Configure Bearer token for authorization: access_token
            config.AccessToken = "YOUR_BEARER_TOKEN";

            var apiInstance = new AttackDetectionApi(config);
            var realm = "realm_example";  // string | realm name (not id!)
            var userId = "userId_example";  // string |

            try
            {
                apiInstance.DeleteBruteForceUser(realm, userId);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling AttackDetectionApi.DeleteBruteForceUser: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

<a id="documentation-for-api-endpoints"></a>

Documentation for API Endpoints

All URIs are relative to https://keycloak.example.com/admin/realms

<a id="documentation-for-models"></a>

Documentation for Models

• Model.Access
• Model.AccessToken
• Model.AddressClaimSet
• Model.AdminEventRepresentation
• Model.ApplicationRepresentation
• Model.ApplicationRepresentationClaims
• Model.AuthDetailsRepresentation
• Model.AuthenticationExecutionExportRepresentation
• Model.AuthenticationExecutionInfoRepresentation
• Model.AuthenticationExecutionRepresentation
• Model.AuthenticationFlowRepresentation
• Model.AuthenticatorConfigInfoRepresentation
• Model.AuthenticatorConfigRepresentation
• Model.Authorization
• Model.CertificateRepresentation
• Model.ClaimRepresentation
• Model.ClientInitialAccessCreatePresentation
• Model.ClientInitialAccessPresentation
• Model.ClientMappingsRepresentation
• Model.ClientPoliciesRepresentation
• Model.ClientPolicyConditionRepresentation
• Model.ClientPolicyExecutorRepresentation
• Model.ClientPolicyRepresentation
• Model.ClientProfileRepresentation
• Model.ClientProfilesRepresentation
• Model.ClientRepresentation
• Model.ClientScopeRepresentation
• Model.ClientTemplateRepresentation
• Model.ComponentExportRepresentation
• Model.ComponentRepresentation
• Model.ComponentTypeRepresentation
• Model.Composites
• Model.ConfigPropertyRepresentation
• Model.Confirmation
• Model.CredentialRepresentation
• Model.EventRepresentation
• Model.FederatedIdentityRepresentation
• Model.GlobalRequestResult
• Model.GroupRepresentation
• Model.IDToken
• Model.IdentityProviderMapperRepresentation
• Model.IdentityProviderMapperTypeRepresentation
• Model.IdentityProviderRepresentation
• Model.InstallationAdapterConfig
• Model.KeyMetadataRepresentation
• Model.KeyStoreConfig
• Model.KeysMetadataRepresentation
• Model.ManagementPermissionReference
• Model.MappingsRepresentation
• Model.MethodConfig
• Model.OAuthClientRepresentation
• Model.PathCacheConfig
• Model.PathConfig
• Model.Permission
• Model.PolicyEnforcerConfig
• Model.PolicyRepresentation
• Model.ProtocolMapperEvaluationRepresentation
• Model.ProtocolMapperRepresentation
• Model.PublishedRealmRepresentation
• Model.RealmEventsConfigRepresentation
• Model.RealmRepresentation
• Model.RequiredActionProviderRepresentation
• Model.ResourceOwnerRepresentation
• Model.ResourceRepresentation
• Model.ResourceRepresentationOwner
• Model.ResourceServerRepresentation
• Model.RoleRepresentation
• Model.RolesRepresentation
• Model.ScopeMappingRepresentation
• Model.ScopeRepresentation
• Model.SocialLinkRepresentation
• Model.UPAttribute
• Model.UPAttributePermissions
• Model.UPAttributeRequired
• Model.UPAttributeSelector
• Model.UPConfig
• Model.UPGroup
• Model.UserConsentRepresentation
• Model.UserFederationMapperRepresentation
• Model.UserFederationProviderRepresentation
• Model.UserProfileAttributeGroupMetadata
• Model.UserProfileAttributeMetadata
• Model.UserProfileMetadata
• Model.UserRepresentation
• Model.UserSessionRepresentation

<a id="documentation-for-authorization"></a>

Documentation for Authorization

Authentication schemes defined for the API: <a id="access_token"></a>

access_token

• Type: Bearer Authentication