user info endpoint

Author: hrbrmstr

NAMESPACE

@@ -8,6 +8,7 @@ export(xforce_malware_for_hash)
 export(xforce_resolve)
 export(xforce_url_malware)
 export(xforce_url_report)
+export(xforce_user_profile)
 export(xforce_whois)
 import(httr)
 importFrom(jsonlite,fromJSON)

R/ip-history.R

@@ -1,4 +1,4 @@
-#' Get IP History
+#' Get IP History/Reputation
 #'
 #' @md
 #' @param ip IP address

R/malware-hash.R

@@ -9,7 +9,7 @@
 #'        [on the IBM X-Force Portal](api_key=Sys.getenv("XFORCE_API_KEY")).
 #' @export
 #' @examples \donrun{
-#' xforce_ip_history("174.62.167.97")
+#' xforce_malware_for_hash("474B9CCF5AB9D72CA8A333889BBB34F0")
 #' }
 xforce_malware_for_hash <- function(hash, api_key=Sys.getenv("XFORCE_API_KEY"),
                                     api_password=Sys.getenv("XFORCE_API_PASSWORD")) {

R/user-profile.R

@@ -0,0 +1,34 @@
+#' Get User Profile
+#'
+#' @md
+#' @param api_key,api_password IBM X-Force API Key & Password. All `xforce`
+#'        API functions will look for these in the `XFORCE_API_KEY` and
+#'        `XFORCE_API_PASSWORD` environment variables. You can store these
+#'        in `~/.Renviron` and you can obtain them
+#'        [on the IBM X-Force Portal](api_key=Sys.getenv("XFORCE_API_KEY")).
+#' @export
+#' @examples \donrun{
+#' xforce_user_profile()
+#' }
+xforce_user_profile <- function(api_key=Sys.getenv("XFORCE_API_KEY"),
+                                api_password=Sys.getenv("XFORCE_API_PASSWORD")) {
+
+  httr::GET(
+    url = "https://api.xforce.ibmcloud.com/user/profile",
+    httr::accept_json(),
+    httr::user_agent("R xforce package (https://github.com/hrbrmstr/xforce"),
+    httr::authenticate(
+      user = api_key,
+      password = api_password
+    )
+  ) -> res
+
+  httr::stop_for_status(res)
+
+  out <- httr::content(res, as = "text")
+
+  out <- jsonlite::fromJSON(out)
+
+  out
+
+}

README.Rmd

@@ -18,13 +18,14 @@ All `xforce` API functions will look for these in the `XFORCE_API_KEY` and
 The following functions are implemented:
 
 - `xforce_as_networks`:	Get Networks Assigned to an Autonomous System Number
-- `xforce_ip_history`:	Get IP History
+- `xforce_ip_history`:	Get IP History/Reputation
 - `xforce_ip_malware`:	Get Malware Associated with the IP
 - `xforce_ip_report`:	Get IP Report
 - `xforce_malware_for_hash`:	Get Malware for File Hash
 - `xforce_resolve`:	Get DNS Records
 - `xforce_url_malware`:	Get Malware for URL
 - `xforce_url_report`:	Get URL Report
+- `xforce_user_profile`:	Get User Profile
 - `xforce_whois`:	Get WHOIS Information for a Host
 
 ## TODO

README.md

@@ -21,13 +21,14 @@ The following functions are implemented:
 
   - `xforce_as_networks`: Get Networks Assigned to an Autonomous System
     Number
-  - `xforce_ip_history`: Get IP History
+  - `xforce_ip_history`: Get IP History/Reputation
   - `xforce_ip_malware`: Get Malware Associated with the IP
   - `xforce_ip_report`: Get IP Report
   - `xforce_malware_for_hash`: Get Malware for File Hash
   - `xforce_resolve`: Get DNS Records
   - `xforce_url_malware`: Get Malware for URL
   - `xforce_url_report`: Get URL Report
+  - `xforce_user_profile`: Get User Profile
   - `xforce_whois`: Get WHOIS Information for a Host
 
 ## TODO