oktakit 0.1.0

data/lib/oktakit/client/groups.rb

@@ -0,0 +1,149 @@
+module Oktakit
+  class Client
+    module Groups
+      # Add Group
+      #
+      # @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 [Hash<Sawyer::Resource>] The created Group.
+      # @see http://developer.okta.com/docs/api/resources/groups.html#add-group
+      # @example
+      #   Oktakit.add_group
+      def add_group(options = {})
+        post('/groups', options)
+      end
+
+      # Get Group
+      #
+      # @params id [string] Group ID
+      # @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 [Hash<Sawyer::Resource>] Fetched Group
+      # @see http://developer.okta.com/docs/api/resources/groups.html#get-group
+      # @example
+      #   Oktakit.get_group('id')
+      def get_group(id, options = {})
+        get("/groups/#{id}", options)
+      end
+
+      # List Groups
+      #
+      # @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 Groups
+      # @see http://developer.okta.com/docs/api/resources/groups.html#list-groups
+      # @example
+      #   Oktakit.list_groups
+      def list_groups(options = {})
+        get('/groups', options)
+      end
+
+      # Update Group
+      #
+      # @params id [string] Group ID
+      # @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 [Hash<Sawyer::Resource>] Updated Group
+      # @see http://developer.okta.com/docs/api/resources/groups.html#update-group
+      # @example
+      #   Oktakit.update_group('id')
+      def update_group(id, options = {})
+        put("/groups/#{id}", options)
+      end
+
+      # Remove Group
+      #
+      # @params id [string] Group ID
+      # @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  HTTP 204 No Content
+      # @see http://developer.okta.com/docs/api/resources/groups.html#remove-group
+      # @example
+      #   Oktakit.remove_group('id')
+      def remove_group(id, options = {})
+        delete("/groups/#{id}", options)
+      end
+
+      # List Group Members
+      #
+      # @params id [string] Group ID
+      # @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 Users
+      # @see http://developer.okta.com/docs/api/resources/groups.html#list-group-members
+      # @example
+      #   Oktakit.list_group_members('id')
+      def list_group_members(id, options = {})
+        get("/groups/#{id}/users", options)
+      end
+
+      # Add User to Group
+      #
+      # @params group_id [string] Group ID
+      # @params user_id [string] User ID
+      # @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  HTTP 204 No Content
+      # @see http://developer.okta.com/docs/api/resources/groups.html#add-user-to-group
+      # @example
+      #   Oktakit.add_user_to_group('group_id', 'user_id')
+      def add_user_to_group(group_id, user_id, options = {})
+        put("/groups/#{group_id}/users/#{user_id}", options)
+      end
+
+      # Remove User from Group
+      #
+      # @params group_id [string] Group ID
+      # @params user_id [string] User ID
+      # @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  HTTP 204 No Content
+      # @see http://developer.okta.com/docs/api/resources/groups.html#remove-user-from-group
+      # @example
+      #   Oktakit.remove_user_from_group('group_id', 'user_id')
+      def remove_user_from_group(group_id, user_id, options = {})
+        delete("/groups/#{group_id}/users/#{user_id}", options)
+      end
+
+      # List Assigned Applications
+      #
+      # @params id [string] Group ID
+      # @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 Applications
+      # @see http://developer.okta.com/docs/api/resources/groups.html#list-assigned-applications
+      # @example
+      #   Oktakit.list_assigned_applications('id')
+      def list_assigned_applications(id, options = {})
+        get("/groups/#{id}/apps", options)
+      end
+    end
+  end
+end

data/lib/oktakit/client/identity_providers.rb

@@ -0,0 +1,274 @@
+module Oktakit
+  class Client
+    module IdentityProviders
+      # Add Identity Provider
+      #
+      # @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 [Hash<Sawyer::Resource>] The created Identity Provider
+      # @see http://developer.okta.com/docs/api/resources/idps.html#add-identity-provider
+      # @example
+      #   Oktakit.add_identity_provider
+      def add_identity_provider(options = {})
+        post('/idps', options)
+      end
+
+      # Get Identity Provider
+      #
+      # @params id [string] IDPS ID
+      # @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 [Hash<Sawyer::Resource>] Identity Provider
+      # @see http://developer.okta.com/docs/api/resources/idps.html#get-identity-provider
+      # @example
+      #   Oktakit.get_identity_provider('id')
+      def get_identity_provider(id, options = {})
+        get("/idps/#{id}", options)
+      end
+
+      # List Identity Providers
+      #
+      # @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 Identity Provider
+      # @see http://developer.okta.com/docs/api/resources/idps.html#list-identity-providers
+      # @example
+      #   Oktakit.list_identity_providers
+      def list_identity_providers(options = {})
+        get('/idps', options)
+      end
+
+      # Update Identity Provider
+      #
+      # @params id [string] IDPS ID
+      # @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 [Hash<Sawyer::Resource>] Updated Identity Provider
+      # @see http://developer.okta.com/docs/api/resources/idps.html#update-identity-provider
+      # @example
+      #   Oktakit.update_identity_provider('id')
+      def update_identity_provider(id, options = {})
+        put("/idps/#{id}", options)
+      end
+
+      # Delete Identity Provider
+      #
+      # @params id [string] IDPS ID
+      # @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  HTTP 204 No Content
+      # @see http://developer.okta.com/docs/api/resources/idps.html#delete-identity-provider
+      # @example
+      #   Oktakit.delete_identity_provider('id')
+      def delete_identity_provider(id, options = {})
+        delete("/idps/#{id}", options)
+      end
+
+      # Activate Identity Provider
+      #
+      # @params id [string] IDPS ID
+      # @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 [Hash<Sawyer::Resource>] Activated Identity Provider
+      # @see http://developer.okta.com/docs/api/resources/idps.html#activate-identity-provider
+      # @example
+      #   Oktakit.activate_identity_provider('id')
+      def activate_identity_provider(id, options = {})
+        post("/idps/#{id}/lifecycle/activate", options)
+      end
+
+      # Deactivate Identity Provider
+      #
+      # @params id [string] IDPS ID
+      # @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 [Hash<Sawyer::Resource>] Deactivated Identity Provider
+      # @see http://developer.okta.com/docs/api/resources/idps.html#deactivate-identity-provider
+      # @example
+      #   Oktakit.deactivate_identity_provider('id')
+      def deactivate_identity_provider(id, options = {})
+        post("/idps/#{id}/lifecycle/deactivate", options)
+      end
+
+      # Get Identity Provider Transaction
+      #
+      # @params transaction_id [string] Transaction ID
+      # @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 [Hash<Sawyer::Resource>] Identity Provider Transaction
+      # @see http://developer.okta.com/docs/api/resources/idps.html#get-identity-provider-transaction
+      # @example
+      #   Oktakit.get_identity_provider_transaction('transaction_id')
+      def get_identity_provider_transaction(transaction_id, options = {})
+        get("/idps/tx/#{transaction_id}", options)
+      end
+
+      # Get Source IdP User for IdP Transaction
+      #
+      # @params transaction_id [string] Transaction ID
+      # @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 [Hash<Sawyer::Resource>] Identity Provider User
+      # @see http://developer.okta.com/docs/api/resources/idps.html#get-source-idp-user-for-idp-transaction
+      # @example
+      #   Oktakit.get_source_idp_user_for_idp_transaction('transaction_id')
+      def get_source_idp_user_for_idp_transaction(transaction_id, options = {})
+        get("/idps/tx/#{transaction_id}/source", options)
+      end
+
+      # Get Target User for IdP Provision Transaction
+      #
+      # @params transaction_id [string] Transaction ID
+      # @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 [Hash<Sawyer::Resource>] Trasformed Okta User Profile
+      # @see http://developer.okta.com/docs/api/resources/idps.html#get-target-user-for-idp-provision-transaction
+      # @example
+      #   Oktakit.get_target_user_for_idp_provision_transaction('transaction_id')
+      def get_target_user_for_idp_provision_transaction(transaction_id, options = {})
+        get("/idps/tx/#{transaction_id}/target", options)
+      end
+
+      # List Users for IdP Link Transaction
+      #
+      # @params transaction_id [string] Transaction ID
+      # @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 Okta User
+      # @see http://developer.okta.com/docs/api/resources/idps.html#list-users-for-idp-link-transaction
+      # @example
+      #   Oktakit.list_users_for_idp_link_transaction('transaction_id')
+      def list_users_for_idp_link_transaction(transaction_id, options = {})
+        get("/idps/tx/#{transaction_id}/users", options)
+      end
+
+      # Provision IdP User
+      #
+      # @params transaction_id [string] Transaction ID
+      # @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 [Hash<Sawyer::Resource>] Identity Provider Transaction
+      # @see http://developer.okta.com/docs/api/resources/idps.html#provision-idp-user
+      # @example
+      #   Oktakit.provision_idp_user('transaction_id')
+      def provision_idp_user(transaction_id, options = {})
+        post("/idps/tx/#{transaction_id}/lifecycle/provision", options)
+      end
+
+      # Link IdP User
+      #
+      # @params transaction_id [string] Transaction ID
+      # @params user_id [string] User ID
+      # @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 [Hash<Sawyer::Resource>] Identity Provider Transaction
+      # @see http://developer.okta.com/docs/api/resources/idps.html#link-idp-user
+      # @example
+      #   Oktakit.link_idp_user('user_id', 'transaction_id')
+      def link_idp_user(transaction_id, user_id, options = {})
+        post("/idps/tx/#{transaction_id}/lifecycle/confirm/#{user_id}", options)
+      end
+
+      # Add X.509 Certificate Public Key
+      #
+      # @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 [Hash<Sawyer::Resource>] Identity Provider Key Credential
+      # @see http://developer.okta.com/docs/api/resources/idps.html#add-x509-certificate-public-key
+      # @example
+      #   Oktakit.add_x509_certificate_public_key
+      def add_x509_certificate_public_key(options = {})
+        post('/idps/credentials/keys', options)
+      end
+
+      # Get Key
+      #
+      # @params key_id [string] Key ID
+      # @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 [Hash<Sawyer::Resource>] Identity Provider Key Credential
+      # @see http://developer.okta.com/docs/api/resources/idps.html#get-key
+      # @example
+      #   Oktakit.get_key('key_id')
+      def get_key(key_id, options = {})
+        get("/idps/credentials/keys/#{key_id}", options)
+      end
+
+      # List Keys
+      #
+      # @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 Identity Provider Key Credential
+      # @see http://developer.okta.com/docs/api/resources/idps.html#list-keys
+      # @example
+      #   Oktakit.list_keys
+      def list_keys(options = {})
+        get('/idps/credentials/keys', options)
+      end
+
+      # Delete Key
+      #
+      # @params key_id [string] Key ID
+      # @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  HTTP 204 No Content
+      # @see http://developer.okta.com/docs/api/resources/idps.html#delete-key
+      # @example
+      #   Oktakit.delete_key('key_id')
+      def delete_key(key_id, options = {})
+        delete("/idps/credentials/keys/#{key_id}", options)
+      end
+    end
+  end
+end

data/lib/oktakit/client/schemas.rb

@@ -0,0 +1,65 @@
+module Oktakit
+  class Client
+    module Schemas
+      # Get User Schema
+      #
+      # @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 [Hash<Sawyer::Resource>] User Schema
+      # @see http://developer.okta.com/docs/api/resources/schemas.html#get-user-schema
+      # @example
+      #   Oktakit.get_user_schema
+      def get_user_schema(options = {})
+        get('/meta/schemas/user/default', options)
+      end
+
+      # Add Property to User Profile Schema
+      #
+      # @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 [Hash<Sawyer::Resource>] User Schema
+      # @see http://developer.okta.com/docs/api/resources/schemas.html#add-property-to-user-profile-schema
+      # @example
+      #   Oktakit.add_property_to_user_profile_schema
+      def add_property_to_user_profile_schema(options = {})
+        post('/meta/schemas/user/default', options)
+      end
+
+      # Update User Profile Schema Property
+      #
+      # @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 [Hash<Sawyer::Resource>] User Schema
+      # @see http://developer.okta.com/docs/api/resources/schemas.html#update-user-profile-schema-property
+      # @example
+      #   Oktakit.update_user_profile_schema_property
+      def update_user_profile_schema_property(options = {})
+        post('/meta/schemas/user/default', options)
+      end
+
+      # Remove Property from User Profile Schema
+      #
+      # @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 [Hash<Sawyer::Resource>] User Schema
+      # @see http://developer.okta.com/docs/api/resources/schemas.html#remove-property-from-user-profile-schema
+      # @example
+      #   Oktakit.remove_property_from_user_profile_schema
+      def remove_property_from_user_profile_schema(options = {})
+        post('/meta/schemas/user/default', options)
+      end
+    end
+  end
+end