idnio 2.3.3b → 2.3.4b

data/lib/objects/campaign-filters.rb

@@ -13,14 +13,22 @@ module CampaignFilters
 
     response = IDNAPI.get( "#{$url}/cc/api/campaignFilter/list?includeSystemFilters=false", $token )
 
-    filters = JSON.parse( response.body )
+    case response
+    when Net::HTTPSuccess
 
-    $log.info "\tDetected #{filters['count']} campaign filters."
+      filters = JSON.parse( response.body )
+
+      $log.info "\tRetrieved #{filters['count']} campaign filters."
+
+      filters['items'].each do |filter|
+        $log.info "\tCampaign Filter: #{filter["name"]}"
+        Program.write_file( "#{directory}/campaign-filters/", "Campaign Filter - #{filter["name"]}.json", JSON.pretty_generate( filter ) )
+      end
+
+    else
+      $log.error "\tError: Unable to retrieve campaign filters."
+    end # case response
 
-    filters['items'].each do |filter|
-      $log.info "\tCampaign Filter: #{filter["name"]}"
-      Program.write_file( "#{directory}/campaign-filters/", "Campaign Filter - #{filter["name"]}.json", JSON.pretty_generate( filter ) )
-    end
   end
 
   #
@@ -35,25 +43,31 @@ module CampaignFilters
   #
   def self.doc
 
-    Markdown.h2( "Campaign Filters" )
-
     response = IDNAPI.get( "#{$url}/cc/api/campaignFilter/list?includeSystemFilters=false", $token )
-    unless response.nil?
-        filters = JSON.parse( response.body )
-
-        $log.info "\tDetected #{filters['count']} campaign filters."
-
-        filters['items'].each do |filter|
-          $log.info "\tCampaign Filter: #{filter["name"]}"
-          Markdown.h3( "#{filter["name"]}" )
-          Markdown.text( "- **Name** - #{filter["name"]}\n" )
-          Markdown.text( "- **Description** - #{filter["description"]}\n" )
-          Markdown.text( "- **Owner** - #{filter["owner"]}\n" )
-          Markdown.text( "- **Mode** - #{filter["mode"]}\n\n" )
-          Markdown.text( "- **Criteria**\n" )
-          Markdown.code( filter["criteriaList"] )
-        end
-    end
+
+    case response
+    when Net::HTTPSuccess
+
+      filters = JSON.parse( response.body )
+
+      $log.info "\tRetrieved #{filters['count']} campaign filters."
+
+      Markdown.h2 "Campaign Filters"
+
+      filters['items'].each do |filter|
+        $log.info "\tCampaign Filter: #{filter["name"]}"
+        Markdown.h3( "#{filter["name"]}" )
+        Markdown.text( "- **Name** - #{filter["name"]}\n" )
+        Markdown.text( "- **Description** - #{filter["description"]}\n" )
+        Markdown.text( "- **Owner** - #{filter["owner"]}\n" )
+        Markdown.text( "- **Mode** - #{filter["mode"]}\n\n" )
+        Markdown.text( "- **Criteria**\n" )
+        Markdown.code( filter["criteriaList"] )
+      end
+
+    else
+      $log.error "\tError: Unable to retrieve campaign filters."
+    end # case response
 
     Markdown.write
   end

data/lib/objects/connectors.rb

@@ -184,7 +184,7 @@ module Connectors
 
       connectors = JSON.parse( response.body )
 
-      $log.info "\tDetected #{connectors['total']} connectors."
+      $log.info "\tRetrieved connectors."
 
       connectors['items'].each do |connector|
 
@@ -192,13 +192,13 @@ module Connectors
           $log.info "\tConnector: #{connector["name"]}"
           Program.write_file( "#{directory}/connectors/", "Connector - #{connector["name"]}.json", JSON.pretty_generate( connector ) )
         else
-          $log.info "\tSkipping Default Connector: #{connector["name"]}"
+          $log.debug "\tSkipping Default Connector: #{connector["name"]}"
         end
 
       end
 
     else
-      $log.error "\tError: Unable to fetch connectors."
+      $log.error "\tError: Unable to retrieve connectors."
     end
   end
 
@@ -262,9 +262,9 @@ module Connectors
 
       connectors = JSON.parse( response.body )
 
-      Markdown.h2 "Connectors"
-      $log.info "\tDetected #{connectors['total']} connectors."
+      $log.info "\tRetrieved connectors."
 
+      Markdown.h2 "Connectors"
       Markdown.text "| Connector Name | Connector Class | Direct Connect | Status |\n"
       Markdown.text "|----------------|-----------------|----------------|--------|\n"
 
@@ -276,13 +276,13 @@ module Connectors
           Markdown.text "| #{connector["name"]} | #{connector["className"]} | #{Program.humanize(connector["directConnect"])} | #{connector["status"]} |\n"
 
         else
-          $log.info "\tSkipping Default Connector: #{connector["name"]}"
+          $log.debug "\tSkipping Default Connector: #{connector["name"]}"
         end
 
       end
 
     else
-      $log.error "\tError: Unable to fetch connectors."
+      $log.error "\tError: Unable to retrieve connectors."
     end
 
   end

data/lib/objects/email-templates.rb

@@ -94,7 +94,7 @@ module EmailTemplates
 
       email_templates = JSON.parse( response.body )
 
-      $log.info "\tDetected #{email_templates['count']} email templates."
+      $log.info "\tRetrieved email templates."
 
       email_templates['items'].each do |email_template|
 
@@ -112,7 +112,7 @@ module EmailTemplates
       end # email_templates['items'].each do |email_template|
 
     else
-      $log.error "\tError: Unable to fetch email templates."
+      $log.error "\tError: Unable to retrieve email templates."
     end # case response
 
   end
@@ -155,7 +155,13 @@ module EmailTemplates
 
           $log.debug "\t\tUpdating email template..."
           response = IDNAPI.post_form( "#{$url}/cc/api/emailTemplate/update", $token, update_params )
-          $log.debug "\t\tEmail template updated."
+
+          case response
+          when Net::HTTPSuccess
+            $log.debug "\t\tEmail template updated."
+          else
+            $log.error "\tError: Unable to update email template."
+          end # case response
 
         else
           $log.debug "\tSkipping Email Template: #{email_template["name"]}"
@@ -181,7 +187,7 @@ module EmailTemplates
 
       email_templates = JSON.parse( response.body )
 
-      $log.info "\tDetected #{email_templates['count']} email templates."
+      $log.info "\tRetrieved email templates."
 
       # Give up if we don't have any email templates to doc
       # if email_templates.nil? || email_templates.empty? || email_templates['count'] == 0 )
@@ -217,7 +223,7 @@ module EmailTemplates
       end # email_templates['items'].each do |email_template|
 
     else
-      $log.error "\tError: Unable to fetch email templates."
+      $log.error "\tError: Unable to retrieve email templates."
     end # case response
 
     Markdown.write

data/lib/objects/identity-attributes.rb

@@ -90,7 +90,7 @@ module IdentityAttributes
       Program.write_file( File.join( directory, "identity-attributes"), "identity-attributes.json", JSON.pretty_generate( identity_attributes ) )
 
     else
-      $log.error "\tError: Unable to fetch identity attributes."
+      $log.error "\tError: Unable to retrieve identity attributes."
     end # case response
 
   end
@@ -167,7 +167,7 @@ module IdentityAttributes
       end # unless identity_attributes.nil? || identity_attributes.empty?
 
     else
-      $log.error "\tError: Unable to fetch identity attributes."
+      $log.error "\tError: Unable to retrieve identity attributes."
     end # case response
 
   end

data/lib/objects/identity-profiles.rb

@@ -80,7 +80,7 @@ module IdentityProfiles
 
       identity_profiles = JSON.parse( response.body )
 
-      $log.info "\tDetected #{identity_profiles.count} identity profiles."
+      $log.info "\tRetrieved #{identity_profiles.count} identity profiles."
 
       identity_profiles.each do |identity_profile|
 
@@ -96,13 +96,13 @@ module IdentityProfiles
           Program.write_file( "#{directory}/identity-profiles/", "Identity Profile - #{idp_details["name"]}.json", JSON.pretty_generate( idp_details ) )
 
         else
-          $log.error "\tError: Unable to fetch identity profile details."
+          $log.error "\tError: Unable to retrieve identity profile details."
         end # case response
 
       end # identity_profiles.each do |identity_profile|
 
     else
-      $log.error "\tError: Unable to fetch identity profiles."
+      $log.error "\tError: Unable to retrieve identity profiles."
     end # case response
 
   end
@@ -114,7 +114,7 @@ module IdentityProfiles
 
     # Read from the file system to determine how many identity profile configurations we have.
     identity_profiles = Program.read_directory("#{directory}/identity-profiles")
-    $log.info "\tDetected #{identity_profiles.length} identity profiles."
+    $log.info "\tRetrieved #{identity_profiles.length} identity profiles."
 
     #
     # Iterate through each identity profile.
@@ -203,7 +203,7 @@ module IdentityProfiles
       identity_profiles = JSON.parse( response.body )
 
       Markdown.h2 "Identity Profiles"
-      $log.info "\tDetected #{identity_profiles.count} identity profiles."
+      $log.info "\tRetrieved #{identity_profiles.count} identity profiles."
 
       identity_profiles.each do |identity_profile|
 
@@ -311,13 +311,13 @@ module IdentityProfiles
 
 
         else
-          $log.error "\tError: Unable to fetch identity profile details."
+          $log.error "\tError: Unable to retrieve identity profile details."
         end # case response
 
       end # identity_profiles.each do |identity_profile|
 
     else
-      $log.error "\tError: Unable to fetch identity profiles."
+      $log.error "\tError: Unable to retrieve identity profiles."
     end # case response
 
     Markdown.write

data/lib/objects/integrations.rb

@@ -18,7 +18,7 @@ module Integrations
 
       integrations = JSON.parse( response.body )
 
-      $log.info "\tDetected #{integrations.count} integrations."
+      $log.info "\tRetrieved #{integrations.count} integrations."
 
       integrations.each do |integration|
 
@@ -28,16 +28,19 @@ module Integrations
       end
 
     else
-      $log.error "\tError: Unable to fetch integrations."
+      $log.error "\tError: Unable to retrieve integrations."
     end # case response
 
   end
 
+  #
+  # Imports Integration configurations.
+  #
   def self.import( directory )
 
     # Read from the file system to determine how many integrations we have.
     integrations = Program.read_directory( "#{directory}/integrations" )
-    $log.info "\tDetected #{integrations.length} integrations."
+    $log.info "\tRetrieved #{integrations.length} integrations."
 
     # Iterate through each transform.
     integrations.each do |integration|
@@ -99,7 +102,7 @@ module Integrations
 
       Markdown.h2 "Integrations"
 
-      $log.info "\tDetected #{integrations.count} integrations."
+      $log.info "\tRetrieved #{integrations.count} integrations."
 
       integrations.each do |integration|
 
@@ -140,7 +143,7 @@ module Integrations
       end
 
     else
-      $log.error "\tError: Unable to fetch integrations."
+      $log.error "\tError: Unable to retrieve integrations."
     end # case response
 
     Markdown.write

data/lib/objects/lifecycle-states.rb

@@ -13,30 +13,42 @@ module LifecycleStates
 
     response = IDNAPI.get( "#{$url}/cc/api/profile/list", $token )
 
-    unless response.nil?
+    case response
+    when Net::HTTPSuccess
 
-      identityProfiles = JSON.parse( response.body )
+      identity_profiles = JSON.parse( response.body )
 
-      identityProfiles.each do |identityProfile|
+      $log.info "\tRetrieved lifecycle states, across #{identity_profiles.count} identity profiles."
 
-        response = IDNAPI.get( "#{$url}/cc/api/profile/get/#{identityProfile["id"]}", $token )
+      identity_profiles.each do |identity_profile|
 
-        unless response.nil?
+        response = IDNAPI.get( "#{$url}/cc/api/profile/get/#{identity_profile["id"]}", $token )
 
-          JSON.parse( response.body )["configuredStates"].each do |lifecycleState|
+        case response
+        when Net::HTTPSuccess
 
-              response = IDNAPI.get( "#{$url}/cc/api/lifecycleState/get/#{lifecycleState["externalId"]}", $token )
+          JSON.parse( response.body )["configuredStates"].each do |lcs|
 
-              lifecycleState = JSON.parse( response.body )
+              response = IDNAPI.get( "#{$url}/cc/api/lifecycleState/get/#{lcs["externalId"]}", $token )
 
-              $log.info "\tLifecycle State: #{identityProfile["name"]} - #{lifecycleState["name"]}"
+              lcs = JSON.parse( response.body )
 
-              Program.write_file( "#{directory}/lifecycle-states/", "Lifecycle States - #{identityProfile["name"]} - #{lifecycleState["name"]}.json", JSON.pretty_generate( lifecycleState ) )
+              $log.info "\tLifecycle State: #{identity_profile["name"]} - #{lcs["name"]}"
+
+              Program.write_file( "#{directory}/lifecycle-states/", "Lifecycle States - #{identity_profile["name"]} - #{lcs["name"]}.json", JSON.pretty_generate( lcs ) )
 
           end
-        end
-      end
-    end
+
+        else
+          $log.error "\tError: Unable to retrieve identity profile details."
+        end # case response
+
+      end # identityProfiles.each do |identityProfile|
+
+    else
+      $log.error "\tError: Unable to retrieve identity profiles."
+    end # case response
+
   end
 
   #
@@ -58,6 +70,8 @@ module LifecycleStates
 
       identity_profiles = JSON.parse( response.body )
 
+      $log.info "\tRetrieved lifecycle states, across #{identity_profiles.count} identity profiles."
+
       Markdown.h2 "Lifecycle States"
 
       identity_profiles.each do |identity_profile|
@@ -85,13 +99,13 @@ module LifecycleStates
           end # unless idp_details["configuredStates"].nil? || idp_details["configuredStates"].empty?
 
         else
-          $log.error "\tError: Unable to fetch identity profile details."
+          $log.error "\tError: Unable to retrieve identity profile details."
         end # case response
 
       end # identity_profiles.each do |identity_profile|
 
     else
-      $log.error "\tError: Unable to fetch identity profile details."
+      $log.error "\tError: Unable to retrieve identity profiles."
     end # case response
 
     Markdown.write

data/lib/objects/password-policies.rb

@@ -82,7 +82,7 @@ module PasswordPolicies
     response = IDNAPI.get( "#{$url}/cc/api/passwordPolicy/list", $token )
     unless response.nil?
         policies = JSON.parse( response.body )
-        $log.info "\tDetected #{policies.count} policies."
+        $log.info "\tRetrieved #{policies.count} policies."
         policies.each do |policy|
           $log.debug "\tPolicy: #{policy["name"]}"
           Program.write_file( "#{directory}/password-policies/", "Password Policy - #{policy["name"]}.json", JSON.pretty_generate( policy ) )

data/lib/objects/password-sync-groups.rb

@@ -73,7 +73,7 @@ module PasswordSyncGroups
     response = IDNAPI.get( "#{$url}/cc/api/passwordSyncGroup/list", $token )
     unless response.nil?
         groups = JSON.parse( response.body )
-        $log.info "\tDetected #{groups.count} sync groups."
+        $log.info "\tRetrieved #{groups.count} sync groups."
         groups.each do |group|
           $log.debug "\tSync Group: #{group["name"]}"
           policyName = PasswordSyncGroups.getPolicyName( group["passwordPolicyId"] )

data/lib/objects/reference-resolver.rb

@@ -18,44 +18,25 @@ module ReferenceResolver
 
   def self.get_identity_ref( name )
 
-    query = {
-      "queryType": "SAILPOINT",
-      "query": {
-        "query": "name:#{name}"
-      }
-    }
-    response = IDNAPI.post_json( "#{$url}/beta/search/identities?count=true&offset=0&limit=1", $token, query )
-
-    unless response['X-Total-Count'].nil?
-      count = response['X-Total-Count'].to_i
-
-      if count == 1 # Make sure we have a unique result.
-
-        identities = JSON.parse( response.body )
-
-        identity = identities.first
-
-        identity_ref = {
-          "type": "IDENTITY",
-          "id": identity['id'],
-          "name": identity['name']
-        }
-
-        return identity_ref
+    result = ReferenceResolver.search_for_single_object( "identities", "name:#{name}" )
 
-      elsif name != "slpt.services"  # We don't have a unique result, and we're not looking up slpt.services, so we'll look that up instead.
+    if !result.nil?
 
-        $log.debug "\t\tCannot resolve unique identity '#{name}'. Resolving identity 'slpt.services' instead."
-        return ReferenceResolver.get_default_identity_ref
+      return {
+        "type": "IDENTITY",
+        "id": result['id'],
+        "name": result['name']
+      }
 
-      else # We don't have a unique result, and we couldn't resolve anything else. Punt. Hopefully we never see this message.
+    elsif name != "slpt.services"  # We don't have a unique result, and we're not looking up slpt.services, so we'll look that up instead.
 
-        $log.debug "\t\tCannot resolve identity '#{name}' . Giving up with no identity."
-        return nil
+      $log.debug "\t\tCannot resolve unique identity '#{name}'. Resolving identity 'slpt.services' instead."
+      return ReferenceResolver.get_default_identity_ref
 
-      end
+    end
 
-    end # if response['X-Total-Count'].nil?
+    # We don't have a unique result, and we couldn't resolve anything else. Punt. Hopefully we never see this message.
+    $log.debug "\t\tCannot resolve identity '#{name}' . Giving up with no identity."
 
     return nil # catch all.
 
@@ -134,4 +115,63 @@ module ReferenceResolver
     return nil
 
   end # def self.get_cluster_ref( name )
+
+  def self.get_entitlement_ref_by_name( name )
+
+    result = ReferenceResolver.search_for_single_object( "entitlements", "name:#{name}" )
+
+    if !result.nil?
+
+      return {
+        "type": "ENTITLEMENT",
+        "id": result['id'],
+        "name": result['name']
+      }
+
+    end
+
+    # We don't have a unique result, and we couldn't resolve anything else. Punt. Hopefully we never see this message.
+    $log.debug "\t\tCannot resolve entitlement '#{name}' . Giving up with no entitlement reference."
+
+    return nil # catch all.
+
+  end
+
+  def self.get_entitlement_ref_by_id( id )
+
+    result = ReferenceResolver.search_for_single_object( "entitlements", "id:#{id}" )
+
+    unless result.nil?
+      return {
+        "type": "ENTITLEMENT",
+        "id": result['id'],
+        "name": result['name']
+      }
+    end
+    return nil
+  end
+
+  def self.search_for_single_object( object, query )
+
+    query = {
+      "queryType": "SAILPOINT",
+      "query": {
+        "query": "#{query}"
+      }
+    }
+    response = IDNAPI.post_json( "#{$url}/beta/search/#{object}?count=true&offset=0&limit=1", $token, query )
+    case response
+    when Net::HTTPSuccess
+      unless response['X-Total-Count'].nil?
+        count = response['X-Total-Count'].to_i
+        if count == 1 # Make sure we have a unique result.
+          result = JSON.parse( response.body )
+          return result.first
+        end # if count == 1
+      end # unless response['X-Total-Count'].nil?
+    end # case response
+    return nil
+    
+  end
+
 end