keycloak-admin 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e6887f2f57beb2339c74a7600a787b3f19cc5eaa171cbf43e94c1c899b75152
-  data.tar.gz: 10639852645add2d77c73719f5ab315ccb0bf9f5e34a4e716b72a919c087d5a5
+  metadata.gz: 832e114e10e83ff18cfb5eaad1c157248da889b5041137ebf28fd30e610ee07d
+  data.tar.gz: e1151d727d5d6d8320db86024e7f10ad81f35a23dc13312aac065757e8664be5
 SHA512:
-  metadata.gz: ea1fded8289d7d3cd89d816cf0949eed2aa07f2cab0bf86afb2a56e26d60dc30d218ce40ef51a4091e3d9c27369c7e4c8316997aa2a5fbed129c457728056de4
-  data.tar.gz: 65301ff7dd19a5240bdd389f61e23615b8aeee911e08d833fac0c9102a27d5ed279c5bf7ba2adc7726fa12583c4b18ab2d297b38e17555beab1b47caa7b5fcdd
+  metadata.gz: eae1ed6f49db46eec2b4463acbd7cf164948aeba4e672f30703f8724bb70d9d441ff469dfd0fa81645821d5d0bfb19ed0bd7376407026fa1467b66c20069c006
+  data.tar.gz: 26818a04afbc95c05e878881d1b7c38e336f5e18a926995390b5e629786c395807276e6ef18c466e61f1600e65cbdd6b4ea6f80ff6e3af5a3ea070c77f18c655

data/CHANGELOG.md

@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+
+## [1.0.1] - 2021-10-14
+
+* List all `Identity Providers`
+* Add Group on Users (thanks to @tomuench)
+* Remove Group from Users (thanks to @tomuench)
+
 ## [1.0.0] - 2021-08-03
 
 * Add `totp` on Users

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    keycloak-admin (1.0.0)
+    keycloak-admin (1.0.1)
       http-cookie (~> 1.0, >= 1.0.3)
       rest-client (~> 2.0)
 

data/README.md

@@ -12,7 +12,7 @@ This gem *does not* require Rails.
 For example, using `bundle`, add this line to your Gemfile.
 
 ```ruby
-gem "keycloak-admin", "1.0.0"
+gem "keycloak-admin", "1.0.1"
 ```
 
 ## Login
@@ -120,6 +120,9 @@ All options have a default value. However, all of them can be changed in your in
 * Get list of client role mappings for a user/group
 * Save client role mappings for a user/group
 * Save realm-level role mappings for a user/group
+* Add a Group on a User
+* Remove a Group from a User
+* Get list of Identity Providers
 * Link/Unlink users to federated identity provider brokers
 * Execute actions emails
 * Send forgot passsword mail
@@ -367,6 +370,16 @@ group_id  = "3a63b5c0-ef8a-47fd-86ed-b5fead18d9b8"
 KeycloakAdmin.realm("a_realm").group(group_id).role_mapper.save_realm_level(role_list)
 ```
 
+### Get list of identity providers
+
+Note: This client requires the `realm-management.view-identity-providers` role.
+
+Returns an array of `KeycloakAdmin::IdentityProviderRepresentation`.
+
+```ruby
+KeycloakAdmin.realm("a_realm").identity_providers.list
+```
+
 ## How to execute library tests
 
 From the `keycloak-admin-api` directory:
@@ -374,4 +387,5 @@ From the `keycloak-admin-api` directory:
 ```
   $ docker build . -t keycloak-admin:test
   $ docker run -v `pwd`:/usr/src/app/ keycloak-admin:test bundle exec rspec spec
-```
+```
+

data/lib/keycloak-admin/client/identity_provider_client.rb

@@ -0,0 +1,31 @@
+module KeycloakAdmin
+  class IdentityProviderClient < Client
+    def initialize(configuration, realm_client)
+      super(configuration)
+      raise ArgumentError.new("realm must be defined") unless realm_client.name_defined?
+      @realm_client = realm_client
+    end
+
+    def list
+      response = execute_http do
+        RestClient::Resource.new(identity_providers_url, @configuration.rest_client_options).get(headers)
+      end
+      JSON.parse(response).map { |provider_as_hash| IdentityProviderRepresentation.from_hash(provider_as_hash) }
+    end
+
+    def get(internal_id_or_alias=nil)
+      response = execute_http do
+        RestClient::Resource.new(identity_providers_url, @configuration.rest_client_options).get(headers)
+      end
+      IdentityProviderRepresentation.from_hash(JSON.parse(response))
+    end
+
+    def identity_providers_url(internal_id_or_alias=nil)
+      if internal_id_or_alias
+        "#{@realm_client.realm_admin_url}/identity-provider/instances/#{internal_id_or_alias}"
+      else
+        "#{@realm_client.realm_admin_url}/identity-provider/instances"
+      end
+    end
+  end
+end

data/lib/keycloak-admin/client/realm_client.rb

@@ -83,6 +83,10 @@ module KeycloakAdmin
       UserClient.new(@configuration, self)
     end
 
+    def identity_providers
+      IdentityProviderClient.new(@configuration, self)
+    end
+
     def user(user_id)
       UserResource.new(@configuration, self, user_id)
     end

data/lib/keycloak-admin/client/user_client.rb

@@ -31,6 +31,27 @@ module KeycloakAdmin
       )
     end
 
+    def add_group(user_id, group_id)
+      RestClient::Request.execute(
+        @configuration.rest_client_options.merge(
+          method: :put,
+          url: "#{users_url(user_id)}/groups/#{group_id}",
+          payload: {},
+          headers: headers
+        )
+      )
+    end
+
+    def remove_group(user_id, group_id)
+      RestClient::Request.execute(
+        @configuration.rest_client_options.merge(
+          method: :delete,
+          url: "#{users_url(user_id)}/groups/#{group_id}",
+          headers: headers
+        )
+      )
+    end
+
     def get(user_id)
       response = execute_http do
         RestClient::Resource.new(users_url(user_id), @configuration.rest_client_options).get(headers)

data/lib/keycloak-admin/representation/identity_provider_representation.rb

@@ -0,0 +1,67 @@
+module KeycloakAdmin
+  class IdentityProviderRepresentation < Representation
+    attr_accessor :alias,
+                  :display_name,
+                  :internal_id,
+                  :provider_id,
+                  :enabled,
+                  :update_profile_first_login_mode,
+                  :trust_email,
+                  :store_token,
+                  :add_read_token_role_on_create,
+                  :authenticate_by_default,
+                  :link_only,
+                  :first_broker_login_flow_alias,
+                  :configuration
+
+    def self.from_hash(hash)
+      if hash.nil?
+        nil
+      else
+        new(
+          hash["alias"],
+          hash["displayName"],
+          hash["internalId"],
+          hash["providerId"],
+          hash["enabled"],
+          hash["updateProfileFirstLoginMode"],
+          hash["trustEmail"],
+          hash["storeToken"],
+          hash["addReadTokenRoleOnCreate"],
+          hash["authenticateByDefault"],
+          hash["linkOnly"],
+          hash["firstBrokerLoginFlowAlias"],
+          hash["config"]
+        )
+      end
+    end
+
+    def initialize(alias_name,
+                   display_name,
+                   internal_id,
+                   provider_id,
+                   enabled,
+                   update_profile_first_login_mode,
+                   trust_email,
+                   store_token,
+                   add_read_token_role_on_create,
+                   authenticate_by_default,
+                   link_only,
+                   first_broker_login_flow_alias,
+                   configuration)
+      @alias                           = alias_name
+      @display_name                    = display_name
+      @internal_id                     = internal_id
+      @provider_id                     = provider_id
+      @enabled                         = enabled
+      @update_profile_first_login_mode = update_profile_first_login_mode
+      @trust_email                     = trust_email
+      @store_token                     = store_token
+      @add_read_token_role_on_create   = add_read_token_role_on_create
+      @authenticate_by_default         = authenticate_by_default
+      @link_only                       = link_only
+      @first_broker_login_flow_alias   = first_broker_login_flow_alias
+      @configuration                   = configuration
+    end
+  end
+end

data/lib/keycloak-admin/version.rb

@@ -1,3 +1,3 @@
 module KeycloakAdmin
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/lib/keycloak-admin.rb

@@ -10,6 +10,7 @@ require_relative "keycloak-admin/client/role_client"
 require_relative "keycloak-admin/client/role_mapper_client"
 require_relative "keycloak-admin/client/token_client"
 require_relative "keycloak-admin/client/user_client"
+require_relative "keycloak-admin/client/identity_provider_client"
 require_relative "keycloak-admin/client/configurable_token_client"
 require_relative "keycloak-admin/representation/camel_json"
 require_relative "keycloak-admin/representation/representation"
@@ -23,6 +24,7 @@ require_relative "keycloak-admin/representation/realm_representation"
 require_relative "keycloak-admin/representation/role_representation"
 require_relative "keycloak-admin/representation/federated_identity_representation"
 require_relative "keycloak-admin/representation/user_representation"
+require_relative "keycloak-admin/representation/identity_provider_representation"
 require_relative "keycloak-admin/resource/base_role_containing_resource"
 require_relative "keycloak-admin/resource/group_resource"
 require_relative "keycloak-admin/resource/user_resource"

data/spec/client/identity_provider_client_spec.rb

@@ -0,0 +1,92 @@
+RSpec.describe KeycloakAdmin::IdentityProviderClient do
+  describe "#identity_providers_url" do
+    let(:realm_name)  { "valid-realm" }
+    let(:provider_id) { nil }
+
+    before(:each) do
+      @built_url = KeycloakAdmin.realm(realm_name).identity_providers.identity_providers_url(provider_id)
+    end
+
+    context "when provider_id is not defined" do
+      let(:provider_id) { nil }
+      it "returns a proper url without provider id" do
+        expect(@built_url).to eq "http://auth.service.io/auth/admin/realms/valid-realm/identity-provider/instances"
+      end
+    end
+
+    context "when provider_id is defined" do
+      let(:provider_id) { "95985b21-d884-4bbd-b852-cb8cd365afc2" }
+      it "returns a proper url with the provider id" do
+        expect(@built_url).to eq "http://auth.service.io/auth/admin/realms/valid-realm/identity-provider/instances/95985b21-d884-4bbd-b852-cb8cd365afc2"
+      end
+    end
+  end
+
+  describe "#list" do
+    let(:realm_name) { "valid-realm" }
+    let(:json_response) do
+      <<-JSON
+      [
+        {
+          "alias": "acme",
+          "displayName": "ACME",
+          "internalId": "20fea77e-ae3d-411e-9467-2b3a20cd3e6d",
+          "providerId": "saml",
+          "enabled": true,
+          "updateProfileFirstLoginMode": "on",
+          "trustEmail": true,
+          "storeToken": false,
+          "addReadTokenRoleOnCreate": false,
+          "authenticateByDefault": false,
+          "linkOnly": false,
+          "firstBrokerLoginFlowAlias": "first broker login",
+          "config": {
+            "hideOnLoginPage": "",
+            "validateSignature": "true",
+            "samlXmlKeyNameTranformer": "KEY_ID",
+            "signingCertificate": "",
+            "postBindingLogout": "false",
+            "nameIDPolicyFormat": "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent",
+            "postBindingResponse": "true",
+            "backchannelSupported": "",
+            "signatureAlgorithm": "RSA_SHA256",
+            "wantAssertionsEncrypted": "false",
+            "xmlSigKeyInfoKeyNameTransformer": "CERT_SUBJECT",
+            "useJwksUrl": "true",
+            "wantAssertionsSigned": "true",
+            "postBindingAuthnRequest": "true",
+            "forceAuthn": "",
+            "wantAuthnRequestsSigned": "true",
+            "singleSignOnServiceUrl": "https://login.microsoftonline.com/test/saml2",
+            "addExtensionsElementWithKeyInfo": "false"
+          }
+        }
+      ]
+      JSON
+    end
+    before(:each) do
+      @identity_provider_client = KeycloakAdmin.realm(realm_name).identity_providers
+
+      stub_token_client
+      allow_any_instance_of(RestClient::Resource).to receive(:get).and_return json_response
+    end
+
+    it "lists identity providers" do
+      identity_providers = @identity_provider_client.list
+      expect(identity_providers.length).to eq 1
+      expect(identity_providers[0].alias).to eq "acme"
+    end
+
+    it "passes rest client options" do
+      rest_client_options = {verify_ssl: OpenSSL::SSL::VERIFY_NONE}
+      allow_any_instance_of(KeycloakAdmin::Configuration).to receive(:rest_client_options).and_return rest_client_options
+
+      expect(RestClient::Resource).to receive(:new).with(
+        "http://auth.service.io/auth/admin/realms/valid-realm/identity-provider/instances", rest_client_options).and_call_original
+
+      identity_providers = @identity_provider_client.list
+      expect(identity_providers.length).to eq 1
+      expect(identity_providers[0].alias).to eq "acme"
+    end
+  end
+end

data/spec/representation/identity_provider_representation_spec.rb

@@ -0,0 +1,113 @@
+RSpec.describe KeycloakAdmin::IdentityProviderRepresentation do
+  describe "#from_hash" do
+    before(:each) do
+      json = <<-JSON
+      {
+        "alias": "acme",
+        "displayName": "ACME",
+        "internalId": "20fea77e-ae3d-411e-9467-2b3a20cd3e6d",
+        "providerId": "saml",
+        "enabled": true,
+        "updateProfileFirstLoginMode": "on",
+        "trustEmail": true,
+        "storeToken": false,
+        "addReadTokenRoleOnCreate": false,
+        "authenticateByDefault": false,
+        "linkOnly": false,
+        "firstBrokerLoginFlowAlias": "first broker login",
+        "config": {
+          "hideOnLoginPage": "",
+          "validateSignature": "true",
+          "samlXmlKeyNameTranformer": "KEY_ID",
+          "signingCertificate": "",
+          "postBindingLogout": "false",
+          "nameIDPolicyFormat": "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent",
+          "postBindingResponse": "true",
+          "backchannelSupported": "",
+          "signatureAlgorithm": "RSA_SHA256",
+          "wantAssertionsEncrypted": "false",
+          "xmlSigKeyInfoKeyNameTransformer": "CERT_SUBJECT",
+          "useJwksUrl": "true",
+          "wantAssertionsSigned": "true",
+          "postBindingAuthnRequest": "true",
+          "forceAuthn": "",
+          "wantAuthnRequestsSigned": "true",
+          "singleSignOnServiceUrl": "https://login.microsoftonline.com/test/saml2",
+          "addExtensionsElementWithKeyInfo": "false"
+        }
+      }
+      JSON
+      payload            = JSON.parse(json)
+      @identity_provider = KeycloakAdmin::IdentityProviderRepresentation.from_hash(payload)
+    end
+
+    it "parses the alias" do
+      expect(@identity_provider.alias).to eq "acme"
+    end
+
+    it "parses the display name" do
+      expect(@identity_provider.display_name).to eq "ACME"
+    end
+
+    it "parses the internalId" do
+      expect(@identity_provider.internal_id).to eq "20fea77e-ae3d-411e-9467-2b3a20cd3e6d"
+    end
+
+    it "parses the provider id" do
+      expect(@identity_provider.provider_id).to eq "saml"
+    end
+
+    it "parses the enabled" do
+      expect(@identity_provider.enabled).to eq true
+    end
+
+    it "parses the update_profile_first_login_mode" do
+      expect(@identity_provider.update_profile_first_login_mode).to eq "on"
+    end
+
+    it "parses the trust_email" do
+      expect(@identity_provider.trust_email).to eq true
+    end
+
+    it "parses the store_token" do
+      expect(@identity_provider.store_token).to eq false
+    end
+
+    it "parses the add_read_token_role_on_create" do
+      expect(@identity_provider.add_read_token_role_on_create).to eq false
+    end
+
+    it "parses the authenticate_by_default" do
+      expect(@identity_provider.authenticate_by_default).to eq false
+    end
+
+    it "parses the link_only" do
+      expect(@identity_provider.link_only).to eq false
+    end
+    
+    it "parses the first_broker_login_flow_alias" do
+      expect(@identity_provider.first_broker_login_flow_alias).to eq "first broker login"
+    end
+
+    it "parses the configuration as a hash with camel properties" do
+      expect(@identity_provider.configuration["hideOnLoginPage"]).to eq ""
+      expect(@identity_provider.configuration["validateSignature"]).to eq "true"
+      expect(@identity_provider.configuration["samlXmlKeyNameTranformer"]).to eq "KEY_ID"
+      expect(@identity_provider.configuration["signingCertificate"]).to eq ""
+      expect(@identity_provider.configuration["postBindingLogout"]).to eq "false"
+      expect(@identity_provider.configuration["nameIDPolicyFormat"]).to eq "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent"
+      expect(@identity_provider.configuration["postBindingResponse"]).to eq "true"
+      expect(@identity_provider.configuration["backchannelSupported"]).to eq ""
+      expect(@identity_provider.configuration["signatureAlgorithm"]).to eq "RSA_SHA256"
+      expect(@identity_provider.configuration["wantAssertionsEncrypted"]).to eq "false"
+      expect(@identity_provider.configuration["xmlSigKeyInfoKeyNameTransformer"]).to eq "CERT_SUBJECT"
+      expect(@identity_provider.configuration["useJwksUrl"]).to eq "true"
+      expect(@identity_provider.configuration["wantAssertionsSigned"]).to eq "true"
+      expect(@identity_provider.configuration["postBindingAuthnRequest"]).to eq "true"
+      expect(@identity_provider.configuration["forceAuthn"]).to eq ""
+      expect(@identity_provider.configuration["wantAuthnRequestsSigned"]).to eq "true"
+      expect(@identity_provider.configuration["singleSignOnServiceUrl"]).to eq "https://login.microsoftonline.com/test/saml2"
+      expect(@identity_provider.configuration["addExtensionsElementWithKeyInfo"]).to eq "false"
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keycloak-admin
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Lorent Lempereur
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-03 00:00:00.000000000 Z
+date: 2021-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http-cookie
@@ -94,6 +94,7 @@ files:
 - lib/keycloak-admin/client/client_role_mappings_client.rb
 - lib/keycloak-admin/client/configurable_token_client.rb
 - lib/keycloak-admin/client/group_client.rb
+- lib/keycloak-admin/client/identity_provider_client.rb
 - lib/keycloak-admin/client/realm_client.rb
 - lib/keycloak-admin/client/role_client.rb
 - lib/keycloak-admin/client/role_mapper_client.rb
@@ -105,6 +106,7 @@ files:
 - lib/keycloak-admin/representation/credential_representation.rb
 - lib/keycloak-admin/representation/federated_identity_representation.rb
 - lib/keycloak-admin/representation/group_representation.rb
+- lib/keycloak-admin/representation/identity_provider_representation.rb
 - lib/keycloak-admin/representation/impersonation_redirection_representation.rb
 - lib/keycloak-admin/representation/impersonation_representation.rb
 - lib/keycloak-admin/representation/realm_representation.rb
@@ -121,12 +123,14 @@ files:
 - spec/client/client_spec.rb
 - spec/client/configurable_token_client_spec.rb
 - spec/client/group_client_spec.rb
+- spec/client/identity_provider_client_spec.rb
 - spec/client/realm_client_spec.rb
 - spec/client/role_client_spec.rb
 - spec/client/role_mapper_client_spec.rb
 - spec/client/token_client_spec.rb
 - spec/client/user_client_spec.rb
 - spec/configuration_spec.rb
+- spec/representation/identity_provider_representation_spec.rb
 - spec/representation/impersonation_representation_spec.rb
 - spec/representation/user_representation_spec.rb
 - spec/resource/group_resource_spec.rb
@@ -136,7 +140,7 @@ homepage: https://github.com/looorent/keycloak-admin-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -151,8 +155,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Keycloak Admin REST API client written in Ruby
 test_files: []