keycloak-admin 0.7.4 → 0.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e59d2429daf60f186a44419025f9ecf6468e948306b10dd07acc6f71ff36bdb
-  data.tar.gz: a82dd0cdce80a82e19372ed04cf4b84f84a0138faac9d7fcc4d3eca1f128507f
+  metadata.gz: 4c3087f9b9079163b0648bd1a3ae30d3526fef7f8f5d7afc59f251b9f23e7507
+  data.tar.gz: 99eeb84049b48e7410e271f4633d0a79b765d9dd5bb4d185469eebe247c98b19
 SHA512:
-  metadata.gz: 4b940501a2a046248b9773d6075e72e6c0717a291646a5dbd583b67b59ab54b9a02b6f7407e2fa75330ad829bd50100155f42245358380163868b48968488caa
-  data.tar.gz: 9ae5a43cfcde48897618294f845c2494ba45e1ecb80d980aa15b99397e9cfc4014a2ef03f36fbdbee1cf8b96f6d5099bae087217901b09f0505cac702967dfa2
+  metadata.gz: 28d689fe25884746e02f3f1dba166a2c78472f7e897680b39efe2c10e782fe52a1f661265e59ee676f65a4ee8cd3cc3b99e77dcb9fc3e8a44b2a92ca976db038
+  data.tar.gz: d065e64a554f1991e1ec4be2c77cfb81d5e811a6db64d452bdafb7e1cf1e0ce4449444446374e9f09472fa07fee6f8a7468311ff44a86bfd7c5e1ff2cd573656

data/CHANGELOG.md

@@ -5,6 +5,11 @@ 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).
 
+## [0.7.5] - 2020-03-28
+
+Thanks to @RomanHargrave
+* Support for working with federated identity provider (broker) links
+
 ## [0.7.4] - 2019-10-17
 
 * Support for Rails 6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    keycloak-admin (0.7.4)
+    keycloak-admin (0.7.5)
       http-cookie (~> 1.0, >= 1.0.3)
       rest-client (~> 2.0)
 
@@ -12,13 +12,15 @@ GEM
     diff-lcs (1.3)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
+    http-accept (1.7.0)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
-    mime-types (3.2.2)
+    mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.0331)
+    mime-types-data (3.2019.1009)
     netrc (0.11.0)
-    rest-client (2.0.2)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 4.0)
       netrc (~> 0.8)

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", "0.7.4"
+gem "keycloak-admin", "0.7.5"
 ```
 
 ## Login
@@ -97,6 +97,7 @@ 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
+* Link/Unlink users to federated identity provider brokers
 
 ### Get an access token
 

data/lib/keycloak-admin.rb

@@ -21,6 +21,7 @@ require_relative "keycloak-admin/representation/impersonation_representation"
 require_relative "keycloak-admin/representation/credential_representation"
 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/resource/base_role_containing_resource"
 require_relative "keycloak-admin/resource/group_resource"

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

@@ -80,6 +80,23 @@ module KeycloakAdmin
       ImpersonationRedirectionRepresentation.from_url(impersonation_url(user_id), headers)
     end
 
+    def link_idp(user_id, idp_id, idp_user_id, idp_username)
+      fed_id_rep                   = FederatedIdentityRepresentation.new
+      fed_id_rep.user_id           = idp_user_id
+      fed_id_rep.user_name         = idp_username
+      fed_id_rep.identity_provider = idp_id
+
+      execute_http do
+        RestClient.post(federated_identity_url(user_id, idp_id), fed_id_rep.to_json, headers)
+      end
+    end
+
+    def unlink_idp(user_id, idp_id)
+      execute_http do
+        RestClient::Resource.new(federated_identity_url(user_id, idp_id), @configuration.rest_client_options).delete(headers)
+      end
+    end
+
     def users_url(id=nil)
       if id
         "#{@realm_client.realm_admin_url}/users/#{id}"
@@ -103,6 +120,12 @@ module KeycloakAdmin
       "#{users_url(user_id)}/impersonation"
     end
 
+    def federated_identity_url(user_id, identity_provider)
+      raise ArgumentError.new("user_id must be defined") if user_id.nil?
+      raise ArgumentError.new("identity_provider must be defined") if identity_provider.nil?
+      "#{users_url(user_id)}/federated-identity/#{identity_provider}"
+    end
+
     private
 
     def build(username, email, password, email_verified, locale)

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

@@ -0,0 +1,15 @@
+module KeycloakAdmin
+  class FederatedIdentityRepresentation < Representation
+    attr_accessor :identity_provider,
+      :user_id,
+      :user_name
+
+    def self.from_hash(hash)
+      rep                   = new
+      rep.identity_provider = hash['identityProvider']
+      rep.user_id           = hash['userId']
+      rep.user_name         = hash['userName']
+      rep
+    end
+  end
+end

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

@@ -10,21 +10,23 @@ module KeycloakAdmin
       :email_verified,
       :first_name,
       :last_name,
-      :credentials
+      :credentials,
+      :federated_identities
 
     def self.from_hash(hash)
-      user                   = new
-      user.id                = hash["id"]
-      user.created_timestamp = hash["createdTimestamp"]
-      user.origin            = hash["origin"]
-      user.username          = hash["username"]
-      user.email             = hash["email"]
-      user.enabled           = hash["enabled"]
-      user.email_verified    = hash["emailVerified"]
-      user.first_name        = hash["firstName"]
-      user.last_name         = hash["lastName"]
-      user.attributes        = hash["attributes"]
-      user.credentials       = hash["credentials"]&.map{ |hash| CredentialRepresentation.from_hash(hash) } || []
+      user                      = new
+      user.id                   = hash["id"]
+      user.created_timestamp    = hash["createdTimestamp"]
+      user.origin               = hash["origin"]
+      user.username             = hash["username"]
+      user.email                = hash["email"]
+      user.enabled              = hash["enabled"]
+      user.email_verified       = hash["emailVerified"]
+      user.first_name           = hash["firstName"]
+      user.last_name            = hash["lastName"]
+      user.attributes           = hash["attributes"]
+      user.credentials          = hash["credentials"]&.map{ |hash| CredentialRepresentation.from_hash(hash) } || []
+      user.federated_identities = hash["federatedIdentities"]&.map { |hash| FederatedIdentityRepresentation.from_hash(hash) } || []
       user
     end
 
@@ -32,5 +34,10 @@ module KeycloakAdmin
       @credentials ||= []
       @credentials.push(credential_representation)
     end
+
+    def add_federated_identity(federated_identity_representation)
+      @federated_identities ||= []
+      @federated_identities.push(federated_identity_representation)
+    end
   end
 end

data/lib/keycloak-admin/version.rb

@@ -1,3 +1,3 @@
 module KeycloakAdmin
-  VERSION = "0.7.4"
+  VERSION = "0.7.5"
 end

data/spec/representation/user_representation_spec.rb

@@ -9,7 +9,7 @@ RSpec.describe KeycloakAdmin::UserRepresentation do
     end
 
     it "can convert to json" do
-      expect(@user.to_json).to eq '{"id":null,"createdTimestamp":1559836000,"origin":null,"username":"test_username","email":null,"enabled":true,"emailVerified":null,"firstName":null,"lastName":null,"attributes":null,"credentials":[]}'
+      expect(@user.to_json).to eq '{"id":null,"createdTimestamp":1559836000,"origin":null,"username":"test_username","email":null,"enabled":true,"emailVerified":null,"firstName":null,"lastName":null,"attributes":null,"credentials":[],"federatedIdentities":[]}'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keycloak-admin
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: 0.7.5
 platform: ruby
 authors:
 - Lorent Lempereur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-17 00:00:00.000000000 Z
+date: 2020-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http-cookie
@@ -103,6 +103,7 @@ files:
 - lib/keycloak-admin/representation/camel_json.rb
 - lib/keycloak-admin/representation/client_representation.rb
 - 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/impersonation_redirection_representation.rb
 - lib/keycloak-admin/representation/impersonation_representation.rb
@@ -150,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Keycloak Admin REST API client written in Ruby