All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
- Client Authorization management support (thanks to @tillawy)
- GitHub-actions setup to execute
rspec
(thanks to @tillawy)
- Add group endpoints (get, children, delete), support for group attributes (thanks to @mkrawc)
- GroupClient#save method now can update an existing group (thanks to @mkrawc)
- RoleClient#save method now can update an existing role (thanks to @mkrawc)
- Add/List realm-role/s to a group, Allow role-names with spaces, List groups assigned to role (thanks to @LiquidMagical)
- Search for groups with parameters (thanks to @@tlloydthwaites)
- Get client by ID, Find client by Client ID, Update Client (thanks to @gee-forr)
- Revert the modifications on the feature 'Update a User' introduced in
1.0.22
. This implementation had breaking changes such as not being able to update several attributes (first_name
,email
, etc).
- Be more permissive about the version of
rest-client
(~> 2.0
) (thanks to @type-face)
- Fetch user's all active sessions (thanks to @prsanjay)
- Check whether a user is locked or not (thanks to @prsanjay)
- Logout users from all the active sessions (thanks to @prsanjay)
- List users who are a member of a group (thanks to @tlloydthwaites)
- Create subgroups (thanks to @neckhair)
- Add subgroups to
GroupRepresentation
(thanks to @neckhair) - Expose
BaseRoleContainingResource.resource_id
(thanks to @neckhair)
- Remove specific realm roles from user (thanks to @tlloydthwaites)
- Get role by name (thanks to @tlloydthwaites)
- List user realm-level role mappings (thanks to @Kazhuu)
- Delete
Client
- Remove
rest-client
warning when adding a group (thanks to @tlloydthwaites)
- Delete all "realm" roles mapped to a user
- Update
Gemfile.lock
to avoid wrong CVE detections. The version of Rails should always be specified by the parent project. This change has no functional impact.
- Add client role on users
- List client roles
- Allow to use multiple
KeycloakAdmin::Client
in the same environment
- When serializing an array to JSON, force the serialization to use
to_json
for each element. In several contexts (e.g. Rails),to_json
is not used.
- Create
Client
- Create
Identity Provider
(Breaking change:IdentityProviderRepresentation.configuration
has been renamed toIdentityProviderRepresentation.config
) - Add
Identity Provider Mapping
- Find service account for a
Client
- List all
Identity Providers
- Add Group on Users (thanks to @tomuench)
- Remove Group from Users (thanks to @tomuench)
- Add
totp
on Users - Add
required_actions
on Users
- Extend
search
function to use complex queries (thanks to @hobbypunk90)
- Bug:
rest_client_options
default value does not match the documentation (wasnil
by default, should be{}
) - Update documentation about client setup (based on Keycloak 11)
- Fix:
Replace request method shorthand with .execute for proper RestClient option support
(thanks to @RomanHargrave) - When sending action emails, add lifespan as an optional parameter (thanks to @hobbypunk90)
Thanks to @hobbypunk90
- Support for action emails and send forgot passsword mail
Thanks to @RomanHargrave
- Support for working with federated identity provider (broker) links
- Support for Rails 6
Thanks to @cederigo:
- For a given user, get her list of groups
Thanks to @vlad-ro:
- Get list of client role mappings for a group
- Save client role mappings for a user/group
- Save realm-level role mappings for a user/group
Thanks to @vlad-ro:
- List users
- List clients
- List groups, create/save a group
- List roles, save a role
- List realms, save/update/delete a realm
- Get list of client role mappings for a user
- Support passing rest client options for user save and search
- Support using gem without ActiveSupport
Thanks to @vlad-ro:
- Support passing rest client options
- More documentation
- More tests
- Better handling of timeouts
- Get user
- Update users
- Save a locale when creating a new user
- Client to access Custom REST API configurable-token
- Support of impersonation