simpleokta 0.1.5

data/lib/simpleokta/client.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'http'
+require 'json'
+require 'erb'
+require 'simpleokta/apps'
+require 'simpleokta/auth_servers'
+require 'simpleokta/groups'
+require 'simpleokta/constants'
+require 'simpleokta/users'
+
+module Simpleokta
+  class Client
+    include Apps
+    include AuthServers
+    include Groups
+    include Constants
+    include Users
+
+    attr_accessor :api_token, :base_api_url
+
+    # Initialize using passed in config hash
+    # @param config [Hash]
+    def initialize(config)
+      @api_token = config[:api_token]
+      @base_api_url = config[:base_api_url]
+      @http ||= HTTP::Client.new
+    end
+
+    # This method will add our api_token to each authorization header to keep our code D.R.Y
+    # @param action [String] the HTTP verb we are sending our request with.
+    #   IE: 'get', 'post', 'put', 'delete'
+    # @param url [String] the URL to send the request to.
+    # @param body [Hash] the request body, set to an empty hash by default.
+    #   Each request may require a different body schema.
+    def call_with_token(action, url, body = {})
+      uri = @base_api_url + url
+      @http
+        .headers(accept: 'application/json', content: 'application/json')
+        .auth("SSWS #{@api_token}")
+        .send(action, uri, { json: body })
+    end
+  end
+end

data/lib/simpleokta/constants.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Simpleokta
+  class Client
+    module Constants
+      API_BASE_PATH = '/api/v1'
+      USER_API_BASE_PATH = "#{API_BASE_PATH}/users"
+      APP_API_BASE_PATH = "#{API_BASE_PATH}/apps"
+      AUTH_SERVER_API_BASE_PATH = "#{API_BASE_PATH}/authorizationServers"
+      GROUP_API_BASE_PATH = "#{API_BASE_PATH}/groups"
+      SYSTEM_LOG_API_BASE_PATH = "#{API_BASE_PATH}/logs"
+      ORG_API_BASE_PATH = "#{API_BASE_PATH}/org"
+    end
+  end
+end

data/lib/simpleokta/groups.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module Simpleokta
+  class Client
+    module Groups
+      # GROUP METHODS
+
+      # Return a specific Group in the okta instance.
+      # @return [Hash<Group Object>]
+      # @param group_id [String] the unique identifier of the group
+      # @see https://developer.okta.com/docs/reference/api/groups/#group-object Group Object
+      def group(group_id)
+        response = call_with_token('get', "#{Constants::GROUP_API_BASE_PATH}/#{group_id}")
+        JSON.parse(response.body)
+      end
+
+      # Return all Groups in the okta instance.
+      # @return [Array<Group Object>]
+      # @see https://developer.okta.com/docs/reference/api/groups/#group-object Group Object
+      def groups
+        response = call_with_token('get', Constants::GROUP_API_BASE_PATH)
+        JSON.parse(response.body)
+      end
+
+      # Return all applications members of a group have automatically assigned to them.
+      # @param group_id [String] the unique identifier of the group
+      # @return [Array<Group Object>]
+      # @see https://developer.okta.com/docs/reference/api/apps/#application-object Application Object
+      def apps_assigned_to_group(group_id)
+        response = call_with_token('get', "#{Constants::GROUP_API_BASE_PATH}/#{group_id}/apps")
+        JSON.parse(response.body)
+      end
+
+      # Set an application to be automatically assigned to members of a group
+      # @param app_id [String] the unique id of the application
+      # @param group_id [String] the unique identifier of the group
+      # @return [Hash<Application Group Object>]
+      # @see https://developer.okta.com/docs/reference/api/apps/#assign-group-to-application Assign Group to Application
+      # @see https://developer.okta.com/docs/reference/api/apps/#application-key-credential-object Application Group Object
+      def assign_group_to_application(app_id, group_id)
+        response = call_with_token('put', "#{Constants::APP_API_BASE_PATH}/#{app_id}/groups/#{group_id}")
+        JSON.parse(response.body)
+      end
+
+      # Set an application to no longer be automatically assigned to members of a group
+      # @param app_id [String] the unique id of the application
+      # @param group_id [String] the unique identifier of the group
+      # @return [Group Assignment]
+      # @see https://developer.okta.com/docs/reference/api/apps/#response-example-34 Group Assignment Response
+      # @see https://developer.okta.com/docs/reference/api/apps/#assign-group-to-application Assign Group To Application
+      def remove_group_from_application(app_id, group_id)
+        call_with_token('delete', "#{Constants::APP_API_BASE_PATH}/#{app_id}/groups/#{group_id}")
+      end
+
+      # Returns an application group assignment
+      # @param app_id [String] the unique id of the application
+      # @param group_id [String] the unique identifier of the group
+      # @return [Group Assignment]
+      # @see https://developer.okta.com/docs/reference/api/apps/#response-example-34 Group Assignment Response
+      def get_assigned_group_for_application(app_id, group_id)
+        response = call_with_token('get', "#{Constants::APP_API_BASE_PATH}/#{app_id}/groups/#{group_id}")
+        JSON.parse(response.body)
+      end
+
+      # Update a group in the okta instance.
+      # @param group_id [String] the unique identifier of the group
+      # @param group_data [Hash] the data you want the group to contain
+      # @return [Hash<Group Object>]
+      # @see https://developer.okta.com/docs/reference/api/apps/#application-object Application Object
+      # @see https://developer.okta.com/docs/reference/api/groups/#update-group Update Group
+      def update_group(group_id, group_data)
+        response = call_with_token('put', "#{Constants::GROUP_API_BASE_PATH}/#{group_id}", group_data)
+        JSON.parse(response.body)
+      end
+
+      # Remove a group from your org.
+      # @param group_id [String] the unique identifier of the group
+      # @return 204 No Content
+      # @see https://developer.okta.com/docs/reference/api/apps/#application-object Application Object
+      # @see https://developer.okta.com/docs/reference/api/groups/#remove-group Remove Group
+      def remove_group(group_id)
+        call_with_token('delete', "#{Constants::GROUP_API_BASE_PATH}/#{group_id}")
+      end
+
+      # Get all members assigned to a group
+      # @param group_id [String] the unique identifier of the group
+      # @return 204 No Content
+      # @see https://developer.okta.com/docs/reference/api/groups/#list-group-members List Group Members
+      def group_members(group_id)
+        response = call_with_token('get', "#{Constants::GROUP_API_BASE_PATH}/#{group_id}/users")
+        JSON.parse(response.body)
+      end
+
+      # Add a user to a group
+      # @param group_id [String] the unique identifier of the group
+      # @param user_id [String] the unique identifier of the user
+      # @return 204 No Content
+      # @see https://developer.okta.com/docs/reference/api/groups/#add-user-to-group
+      def add_user_to_group(group_id, user_id)
+        call_with_token('put', "#{Constants::GROUP_API_BASE_PATH}/#{group_id}/users/#{user_id}")
+      end
+
+      # Remove a user from a group
+      # @param group_id [String] the unique identifier of the group
+      # @param user_id [String] the unique identifier of the user
+      # @return 204 No Content
+      # @see https://developer.okta.com/docs/reference/api/groups/#remove-user-from-group Add User To Group
+      def remove_user_from_group(group_id, user_id)
+        call_with_token('delete', "#{Constants::GROUP_API_BASE_PATH}/#{group_id}/users/#{user_id}")
+      end
+    end
+  end
+end

data/lib/simpleokta/users.rb

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+module Simpleokta
+  class Client
+    module Users
+      # USER METHODS
+
+      # Return all users in an okta instance
+      # @return [Array<User>]
+      # @see https://developer.okta.com/docs/reference/api/users/#user-object User Object
+      def users
+        response = call_with_token('get', Constants::USER_API_BASE_PATH)
+        JSON.parse(response.body)
+      end
+
+      # Return a specific user in an okta instance
+      # @param user_id [String] the unique id of a user in the okta instance
+      # @return [Hash<User>]
+      # @see https://developer.okta.com/docs/reference/api/users/#user-object User Object
+      def user(user_id)
+        response = call_with_token('get', "#{Constants::USER_API_BASE_PATH}/#{user_id}")
+        JSON.parse(response.body)
+      end
+
+      # Return a specific user in an okta instance
+      # @param login [String] the login email of the user
+      # @return [Hash<User>]
+      # @see https://developer.okta.com/docs/reference/api/users/#user-object User Object
+      def user_from_login(login)
+        response = call_with_token('get', "#{Constants::USER_API_BASE_PATH}/#{ERB::Util.url_encode(login)}")
+        JSON.parse(response.body)
+      end
+
+      # Create a user in the okta instance without credentials
+      # @param user_profile_data [Hash] the required fields to create a user in okta.
+      #   At minimum, this should contain the Profile object.
+      # @example Profile Object
+      #     "profile": {
+      #       "firstName": "Isaac",
+      #       "lastName": "Brock",
+      #       "email": "isaac.brock@example.com",
+      #       "login": "isaac.brock@example.com",
+      #       "mobilePhone": "555-415-1337"
+      #     }
+      # @return [Hash<User>]
+      # @see https://developer.okta.com/docs/reference/api/users/#create-user Create User
+      # @see https://developer.okta.com/docs/reference/api/users/#profile-object Profile Object
+      def create_user(user_profile_data)
+        response = call_with_token('post', "#{Constants::USER_API_BASE_PATH}?activate=false", user_profile_data)
+        JSON.parse(response.body)
+      end
+
+      # Create an activated user in the okta instance without credentials
+      # @param user_profile_data [Hash] the required fields to create a user in okta.
+      #   At minimum, this should contain the Profile object.
+      # @return [Hash<User>]
+      # @see https://developer.okta.com/docs/reference/api/users/#create-user Create User
+      # @see https://developer.okta.com/docs/reference/api/users/#profile-object Profile Object
+      def create_and_activate_user(user_profile_data)
+        response = call_with_token('post', "#{Constants::USER_API_BASE_PATH}?activate=true", user_profile_data)
+        JSON.parse(response.body)
+      end
+
+      # Create a user in the okta insance, and have the user added to groups
+      # @param user_profile_data [Hash] the required fields to create a user in okta.
+      #   At minimum, this should contain the Profile object.
+      # @param group_id_array [Array<String>] the group ids the user should be added to
+      # @return [Hash<User>]
+      # @see https://developer.okta.com/docs/reference/api/users/#user-object User Object
+      # @see https://developer.okta.com/docs/reference/api/users/#create-user-in-group Create User in Group
+      def create_user_in_group(user_profile_data, group_id_array)
+        body = user_profile_data
+        body[:groupIds] = group_id_array
+        response = call_with_token('post', Constants::USER_API_BASE_PATH, body)
+        JSON.parse(response.body)
+      end
+
+      # Delete a user in the okta instance
+      # @param user_id [String] the unique id of a user in the okta instance
+      # @return [Hash<User>]
+      # @see https://developer.okta.com/docs/reference/api/users/#user-object User Object
+      def delete_user(user_id)
+        response = call_with_token('delete', "#{Constants::USER_API_BASE_PATH}/#{user_id}")
+        response
+      end
+
+      # Update a user in the okta instance
+      # @param user_id [String] the unique id of a user in the okta instance
+      # @param user_profile_data [Hash] the required fields to create a user in okta.
+      #   At minimum, this should contain the Profile object.
+      #   Any fields not passed in user_profile_data will be set to null in the user data
+      # @return [Hash<User>]
+      # @see https://developer.okta.com/docs/reference/api/users/#user-object User Object
+      def update_user(user_id, user_profile_data)
+        response = call_with_token('put', "#{Constants::USER_API_BASE_PATH}/#{user_id}", user_profile_data)
+        JSON.parse(response.body)
+      end
+
+      # Activate a user in the okta instance.
+      #   Users created are not immediately activated until they log on. This method bypasses that requirement
+      # @param user_id [String] the unique id of a user in the okta instance
+      # @param send_email [Boolean] whether or not to send an activation email to the user
+      # @return [Hash] contains information on activation.
+      #   If send_email is set to True, returns an empty hash.
+      # @see https://developer.okta.com/docs/reference/api/users/#activate-user Activate User
+      def activate_user(user_id, send_email)
+        response = call_with_token('post',
+                                   "#{Constants::USER_API_BASE_PATH}/#{user_id}/lifecycle/activate?sendEmail=#{send_email}")
+        JSON.parse(response.body)
+      end
+
+      # Reactivates a user in the okta instance that was deactivated.
+      # @param user_id [String] the unique id of a user in the okta instance
+      # @param send_email [Boolean] whether or not to send an activation email to the user
+      # @return [Hash] contains information on activation.
+      #   If send_email is set to True, returns an empty hash.
+      # @see https://developer.okta.com/docs/reference/api/users/#reactivate-user Reactivate User
+      def reactivate_user(user_id, send_email)
+        response = call_with_token('post',
+                                   "#{Constants::USER_API_BASE_PATH}/#{user_id}/lifecycle/reactivate?sendEmail=#{send_email}")
+        JSON.parse(response.body)
+      end
+
+      # Deactivates a user in the okta instance.
+      # @param user_id [String] the unique id of a user in the okta instance
+      # @param send_email [Boolean] whether or not to send an activation email to the user
+      # @return [Hash] empty hash
+      # @see https://developer.okta.com/docs/reference/api/users/#deactivate-user Deactivate User
+      def deactivate_user(user_id, send_email)
+        response = call_with_token('post',
+                                   "#{Constants::USER_API_BASE_PATH}/#{user_id}/lifecycle/deactivate?sendEmail=#{send_email}")
+        JSON.parse(response.body)
+      end
+
+      # Suspend a user in the okta instance.
+      # @param user_id [String] the unique id of a user in the okta instance
+      # @return [Hash] empty hash
+      # @see https://developer.okta.com/docs/reference/api/users/#suspend-user Suspend User
+      def suspend_user(user_id)
+        call_with_token('post', "#{Constants::USER_API_BASE_PATH}/#{user_id}/lifecycle/suspend")
+      end
+
+      # Unsuspend a user in the okta instance.
+      #   Sets the user status to ACTIVE.
+      # @param user_id [String] the unique id of a user in the okta instance
+      # @return [Hash] empty hash
+      # @see https://developer.okta.com/docs/reference/api/users/#unsuspend-user Unsuspend User
+      def unsuspend_user(user_id)
+        call_with_token('post', "#{Constants::USER_API_BASE_PATH}/#{user_id}/lifecycle/unsuspend")
+      end
+
+      # Unlocks a user in the okta instance.
+      #   Only available when a user has LOCKED_OUT status.
+      #   Sets the user status to ACTIVE.
+      # @param user_id [String] the unique id of a user in the okta instance
+      # @return [Hash] empty hash
+      # @see https://developer.okta.com/docs/reference/api/users/#unlock-user Unlock User
+      def unlock_user(user_id)
+        call_with_token('post', "#{Constants::USER_API_BASE_PATH}/#{user_id}/lifecycle/unlock")
+      end
+
+      # List all applications a user currently has assigned to them.
+      # @param user_id [String] the unique id of a user in the okta instance
+      # @return [Array<Application Object>]
+      # @see https://developer.okta.com/docs/reference/api/apps/#application-object Application Object
+      # @see https://developer.okta.com/docs/reference/api/apps/#list-applications-assigned-to-a-user List Applications Assigned to User
+      def apps_assigned_to_user(user_id)
+        response = call_with_token('get', "#{Constants::APP_API_BASE_PATH}/?filter=user.id+eq+\"#{user_id}\"")
+        JSON.parse(response.body)
+      end
+    end
+  end
+end

data/lib/simpleokta/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Simpleokta
+  VERSION = '0.1.5'
+end

data/simpleokta.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'lib/simpleokta/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'simpleokta'
+  spec.version       = Simpleokta::VERSION
+  spec.authors       = ['Braden Shipley']
+  spec.email         = ['simpleokta@gmail.com']
+
+  spec.summary       = 'A Simple Okta Gem that helps perform common Okta Calls.'
+  spec.description   = 'A Simple Okta Gem that helps perform common Okta Calls.'
+  spec.homepage      = 'https://github.com/bradenshipley/simpleokta'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/bradenshipley/simpleokta'
+  spec.metadata['changelog_uri'] = 'https://github.com/bradenshipley/simpleokta/changelog.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  # Gem Dependencies
+  spec.add_dependency('http')
+end

data/solargraph

@@ -0,0 +1,29 @@
+#!/System/Library/Frameworks/Ruby.framework/Versions/2.6/usr/bin/ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by RubyGems.
+#
+# The application 'solargraph' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'rubygems'
+
+version = '>= 0.a'
+
+str = ARGV.first
+if str
+  str = str.b[/\A_(.*)_\z/, 1]
+  if str && Gem::Version.correct?(str)
+    version = str
+    ARGV.shift
+  end
+end
+
+if Gem.respond_to?(:activate_bin_path)
+  load Gem.activate_bin_path('solargraph', 'solargraph', version)
+else
+  gem 'solargraph', version
+  load Gem.bin_path('solargraph', 'solargraph', version)
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: simpleokta
+version: !ruby/object:Gem::Version
+  version: 0.1.5
+platform: ruby
+authors:
+- Braden Shipley
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Simple Okta Gem that helps perform common Okta Calls.
+email:
+- simpleokta@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simpleokta.rb
+- lib/simpleokta/apps.rb
+- lib/simpleokta/auth_servers.rb
+- lib/simpleokta/client.rb
+- lib/simpleokta/constants.rb
+- lib/simpleokta/groups.rb
+- lib/simpleokta/users.rb
+- lib/simpleokta/version.rb
+- simpleokta.gemspec
+- solargraph
+homepage: https://github.com/bradenshipley/simpleokta
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/bradenshipley/simpleokta
+  source_code_uri: https://github.com/bradenshipley/simpleokta
+  changelog_uri: https://github.com/bradenshipley/simpleokta/changelog.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.13
+signing_key:
+specification_version: 4
+summary: A Simple Okta Gem that helps perform common Okta Calls.
+test_files: []