Merge pull request #5 from bugcrowd/profile-mapping

Add support for list/get/update profile mappings

Author: mo5h

Gemfile.lock

@@ -83,6 +83,7 @@ GEM
 PLATFORMS
   -darwin-21
   arm64-darwin-21
+  arm64-darwin-22
   arm64-darwin-24
   x86_64-linux
 

lib/oktakit/client.rb

@@ -9,6 +9,7 @@
 require 'oktakit/client/identity_providers'
 require 'oktakit/client/policies'
 require 'oktakit/client/policy_rules'
+require 'oktakit/client/profile_mappings'
 require 'oktakit/client/schemas'
 require 'oktakit/client/templates'
 require 'oktakit/client/users'
@@ -24,6 +25,7 @@ class Client
     include IdentityProviders
     include Policies
     include PolicyRules
+    include ProfileMappings
     include Schemas
     include Templates
     include Users

lib/oktakit/client/profile_mappings.rb

@@ -0,0 +1,50 @@
+module Oktakit
+  class Client
+    module ProfileMappings
+      # List ProfileMappings
+      #
+      # @param options[:query] [Hash] Optional. Query params for request
+      # @param options[:headers] [Hash] Optional. Header params for the request.
+      # @param options[:accept] [String] Optional. The content type to accept. Default application/json
+      # @param options[:content_type] [String] Optional. The content type for the request. Default application/json
+      # @param options [Hash] Optional. Body params for request.
+      # @return [Array<Sawyer::Resource>] Array of ProfileMappings
+      # @see https://developer.okta.com/docs/api/openapi/okta-management/management/tag/ProfileMapping/#tag/ProfileMapping/operation/listProfileMappings
+      # @example
+      #   Oktakit.list_profile_mappings(query: {type: 'IDP_DISCOVERY'})
+      def list_profile_mappings(options = {})
+        get("/mappings", options)
+      end
+
+      # Retrieve a profile_mapping
+      #
+      # @param options[:query] [Hash] Optional. Query params for request
+      # @param options[:headers] [Hash] Optional. Header params for the request.
+      # @param options[:accept] [String] Optional. The content type to accept. Default application/json
+      # @param options[:content_type] [String] Optional. The content type for the request. Default application/json
+      # @param options [Hash] Optional. Body params for request.
+      # @return [Sawyer::Resource] ProfileMapping
+      # @see https://developer.okta.com/docs/api/openapi/okta-management/management/tag/ProfileMapping/#tag/ProfileMapping/operation/getProfileMapping
+      # @example
+      #   Oktakit.get_profile_mapping('id')
+      def get_profile_mapping(id, options = {})
+        get("/mappings/#{id}", options)
+      end
+
+      # Update a profile_mapping
+      #
+      # @param options[:query] [Hash] Optional. Query params for request
+      # @param options[:headers] [Hash] Optional. Header params for the request.
+      # @param options[:accept] [String] Optional. The content type to accept. Default application/json
+      # @param options[:content_type] [String] Optional. The content type for the request. Default application/json
+      # @param options [Hash] Optional. Body params for request.
+      # @return [Sawyer::Resource] The updated ProfileMapping
+      # @see https://developer.okta.com/docs/api/openapi/okta-management/management/tag/ProfileMapping/#tag/ProfileMapping/operation/replaceProfileMapping
+      # @example
+      #   Oktakit.update_profile_mapping('id', options)
+      def update_profile_mapping(id, options = {})
+        post("/mappings/#{id}", options)
+      end
+    end
+  end
+end

spec/cassettes/get_profile_mapping.yml

@@ -0,0 +1,40 @@
+require "spec_helper"
+
+describe Oktakit::Client::ProfileMappings do
+  PROFILE_MAPPING_ID = "aprofilemappingid"
+  PROFILE_MAPPING_SOURCE_ID = "aprofilesourceid"
+
+  describe "#list_profile_mappings" do
+    it "returns array of profile_mappings" do
+      VCR.use_cassette("list_profile_mappings") do
+        resp, = client.list_profile_mappings(query: { sourceId: PROFILE_MAPPING_SOURCE_ID })
+        expect(resp).to(be_a(Array))
+      end
+    end
+  end
+
+  describe "#get_profile_mapping" do
+    it "returns the fetched profile_mapping." do
+      VCR.use_cassette("get_profile_mapping") do
+        resp, = client.get_profile_mapping(PROFILE_MAPPING_ID)
+        expect(resp.id).not_to(be_nil)
+        expect(resp.id).to(be == PROFILE_MAPPING_ID)
+      end
+    end
+  end
+
+  describe "#update_profile_mapping" do
+    it "returns the updated profile_mapping." do
+      VCR.use_cassette("update_profile_mapping") do
+        resp, = client.update_profile_mapping(
+          PROFILE_MAPPING_ID,
+          "properties": { "email": {
+            "expression": "appuser.subjectNameId",
+            "pushStatus": "DONT_PUSH",
+          } }
+        )
+        expect(resp.id).not_to(be_nil)
+      end
+    end
+  end
+end