KeycloakStandard

Keycloak wrapper in .NET Standard

Getting started

KeycloakStandard is a library for working with Keycloak from .NET Standard 2.0, which means you can call this library from .NET Framework (>= 4.6.1), .NET Core (>= 2.0) and others.

Check if your project is compliant with .NET Standard 2.0.

Getting started

1. To start with this library, you need to install this from Nuget via Package Manager:

Install-Package KeycloakStandard

2. To begin with the coding part, you need to first make an instance of ClientData object that resides under KeycloakStandard.Models namespace and fill every property under that object:

ClientData clientData = new ClientData()
{
    ...
};

3. Next, you need to make an instance of Client object that resides under KeycloakStandard namespace:

Client<TUserIdType> client = new Client<TUserIdType>(clientData);

Notice TUserIdType in that line. I have left the room for that. By default user Id in Keycloak database is varying(36) (PostgreSQL) which means that you will place string instead of TUserIdType and you will follow that rule no matter what database you are using. The reason behind this generic is that maybe there are modified versions of Keycloak where someone placed int as a data type for user Id.

Login

To authenticate (login) user in the Keycloak all the information you need is username and password of that user:

var tokenResult = await client.KeycloakLogin("TestUsername", "TestPassword");

User registration

To register new user in the Keycloak database, you need to make an instance of Registration object that resides under KeycloakStandard.Models namespace and fill the data:

Registration registration = new Registration
{
    ...
};

Then, you pass that Registration object to KeycloakRegistration method:

var tokenResult = await client.KeycloakRegistration(registration);

Logout user

First, you need to make an instance of Logout object and fill the data. Logout resides under KeycloakStandard.Models namespace:

Logout logout = new Logout()
{
    ...
};

To logout currently logged user in, you will work with KeycloakLogout method and pass created Logout object as a parameter to that method:

bool isLoggedOut = await client.KeycloakLogout(logout);

Delete user

First, you need to make an instance of DeleteUser object and fill the data. DeleteUser resides under KeycloakStandard.Models namespace:

DeleteUser<TUserIdType> deleteUser = new DeleteUser<TUserIdType>()
{
    ...
};

Explanation for TUserIdType in this example is the same as in the example above.

To delete existing user, you will work with KeycloakDeleteUser method and pass created DeleteUser object as a parameter to that method:

bool isUserDeleted = await client.KeycloakDeleteUser(deleteUser);

Create Keycloak client

Make an instance of KeycloakClient object and fill the data. The only part that you MUST fill is ClientId which is the name of the client you are creating. Other parameters are optional, but it would be good to fill them at the creation, so you don't need to update your client.

KeycloakClient object resides under KeycloakStandard.Models namespace:

KeycloakClient keycloakClient = new KeycloakClient()
{
    ...
};

Also, you will need to provide access token in order to create a new client. After you have filled all the data, you can now create a new client:

bool isCreated = await client.CreateClient(keycloakClient, accessToken);

Get list of all clients

To get list of all clients, you need access token.

Code to get list of all clients:

ICollection<KeycloakClient> allClients = await client.GetAllClients(accessToken);

Delete client

To delete Keycloak client, you will need guid of that client (you can get it with getting all clients) and access token. With those information, you can delete a client:

bool isDeleted = await client.DeleteClient(clientGuid, accessToken);

Update client

To update Keycloak client, you will need filled KeycloakClient object that resides under KeycloakStandard.Models namespace, access token and client guid. With those information, you can update a client:

bool isDeleted = await client.UpdateClient(keycloakClient, accessToken, clientGuid);

Supporting repository

You can support this repository by contributing on it or by sponsoring it.