feat(servicenow-cmdb): new ServiceNow CMDB integration

CMDB Instance API: records list by CI class, record get with
attributes + inbound/outbound relations, record create/update with
attributes and discovery source, add/delete relations. Basic or
OAuth 2.0 (password grant) authentication, stdlib-only scripts.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
Guillaume BOURGEOIS
2026-07-10 22:54:01 +02:00
parent 1ca5597453
commit 527d6f79fd
8 changed files with 735 additions and 0 deletions
@@ -0,0 +1,96 @@
import base64, json, os, sys, urllib.parse, urllib.request, urllib.error
def _cfg():
return json.loads(os.environ.get("INTEGRATION_SECRETS", "{}"))
def _headers(cfg):
h = {"Accept": "application/json", "Content-Type": "application/json"}
if str(cfg.get("auth_type") or "basic").lower() == "oauth":
data = urllib.parse.urlencode({
"grant_type": "password",
"client_id": cfg.get("client_id", ""),
"client_secret": cfg.get("client_secret", ""),
"username": cfg.get("username", ""),
"password": cfg.get("password", ""),
}).encode("utf-8")
req = urllib.request.Request(
cfg.get("url", "").rstrip("/") + "/oauth_token.do", data=data,
headers={"Content-Type": "application/x-www-form-urlencoded", "Accept": "application/json"}, method="POST")
with urllib.request.urlopen(req, timeout=60) as r:
tok = json.loads(r.read())
if not tok.get("access_token"):
raise Exception("OAuth token request failed: " + json.dumps(tok))
h["Authorization"] = "Bearer " + tok["access_token"]
else:
cred = (cfg.get("username", "") + ":" + cfg.get("password", "")).encode("utf-8")
h["Authorization"] = "Basic " + base64.b64encode(cred).decode("ascii")
return h
def request(method, path, params=None, body=None, root="/api/now", versioned=True):
cfg = _cfg()
v = str(cfg.get("api_version") or "").strip().strip("/")
url = cfg.get("url", "").rstrip("/") + root + ("/" + v if v and versioned else "") + path
q = {k: str(x) for k, x in (params or {}).items() if x not in (None, "")}
if q:
url += "?" + urllib.parse.urlencode(q)
data = json.dumps(body).encode("utf-8") if body is not None else None
req = urllib.request.Request(url, data=data, headers=_headers(cfg), method=method)
with urllib.request.urlopen(req, timeout=90) as r:
raw = r.read()
return json.loads(raw) if raw else {}
def relation_params(inputs):
fields = str(inputs.get("fields") or "")
if fields:
parts = [p.strip() for p in fields.split(",") if p.strip()]
for required in ("sys_id", "name"):
if required not in parts:
parts.append(required)
fields = ",".join(parts)
return {
"sysparm_fields": fields or None,
"sysparm_relation_limit": int(inputs.get("relation_limit") or 50),
"sysparm_relation_offset": int(inputs.get("relation_offset") or 0),
}
def parse_relations(s):
if s in (None, ""):
return None
rel = json.loads(s) if isinstance(s, str) else s
if not isinstance(rel, list):
raise Exception("relations must be a JSON array of {type, target} objects")
return rel
def main():
inputs = json.loads(os.environ.get("INTEGRATION_INPUTS", "{}"))
ci_class = str(inputs.get("class") or "")
sys_id = str(inputs.get("sys_id") or "")
if not ci_class or not sys_id:
raise Exception("class and sys_id are required")
body = {"source": str(inputs.get("source") or "ServiceNow")}
inbound = parse_relations(inputs.get("inbound_relations"))
if inbound is not None:
body["inbound_relations"] = inbound
outbound = parse_relations(inputs.get("outbound_relations"))
if outbound is not None:
body["outbound_relations"] = outbound
if "inbound_relations" not in body and "outbound_relations" not in body:
raise Exception("inbound_relations or outbound_relations is required")
path = "/cmdb/instance/" + urllib.parse.quote(ci_class) + "/" + urllib.parse.quote(sys_id) + "/relation"
print(json.dumps(request("POST", path, params=relation_params(inputs), body=body)))
try:
main()
except urllib.error.HTTPError as e:
print(json.dumps({"error": "HTTP " + str(e.code), "detail": e.read().decode("utf-8", "replace")}))
sys.exit(1)
except Exception as e:
print(json.dumps({"error": str(e)}))
sys.exit(1)
@@ -0,0 +1,111 @@
import base64, json, os, sys, urllib.parse, urllib.request, urllib.error
def _cfg():
return json.loads(os.environ.get("INTEGRATION_SECRETS", "{}"))
def _headers(cfg):
h = {"Accept": "application/json", "Content-Type": "application/json"}
if str(cfg.get("auth_type") or "basic").lower() == "oauth":
data = urllib.parse.urlencode({
"grant_type": "password",
"client_id": cfg.get("client_id", ""),
"client_secret": cfg.get("client_secret", ""),
"username": cfg.get("username", ""),
"password": cfg.get("password", ""),
}).encode("utf-8")
req = urllib.request.Request(
cfg.get("url", "").rstrip("/") + "/oauth_token.do", data=data,
headers={"Content-Type": "application/x-www-form-urlencoded", "Accept": "application/json"}, method="POST")
with urllib.request.urlopen(req, timeout=60) as r:
tok = json.loads(r.read())
if not tok.get("access_token"):
raise Exception("OAuth token request failed: " + json.dumps(tok))
h["Authorization"] = "Bearer " + tok["access_token"]
else:
cred = (cfg.get("username", "") + ":" + cfg.get("password", "")).encode("utf-8")
h["Authorization"] = "Basic " + base64.b64encode(cred).decode("ascii")
return h
def request(method, path, params=None, body=None, root="/api/now", versioned=True):
cfg = _cfg()
v = str(cfg.get("api_version") or "").strip().strip("/")
url = cfg.get("url", "").rstrip("/") + root + ("/" + v if v and versioned else "") + path
q = {k: str(x) for k, x in (params or {}).items() if x not in (None, "")}
if q:
url += "?" + urllib.parse.urlencode(q)
data = json.dumps(body).encode("utf-8") if body is not None else None
req = urllib.request.Request(url, data=data, headers=_headers(cfg), method=method)
with urllib.request.urlopen(req, timeout=90) as r:
raw = r.read()
return json.loads(raw) if raw else {}
def relation_params(inputs):
fields = str(inputs.get("fields") or "")
if fields:
parts = [p.strip() for p in fields.split(",") if p.strip()]
for required in ("sys_id", "name"):
if required not in parts:
parts.append(required)
fields = ",".join(parts)
return {
"sysparm_fields": fields or None,
"sysparm_relation_limit": int(inputs.get("relation_limit") or 50),
"sysparm_relation_offset": int(inputs.get("relation_offset") or 0),
}
def split_attrs(s):
out = {}
for part in str(s or "").split(";"):
if "=" not in part:
continue
k, v = part.split("=", 1)
k = k.strip()
if k:
out[k] = v
return out
def parse_relations(s):
if s in (None, ""):
return None
rel = json.loads(s) if isinstance(s, str) else s
if not isinstance(rel, list):
raise Exception("relations must be a JSON array of {type, target} objects")
return rel
def main():
inputs = json.loads(os.environ.get("INTEGRATION_INPUTS", "{}"))
ci_class = str(inputs.get("class") or "")
if not ci_class:
raise Exception("class is required")
attributes = split_attrs(inputs.get("attributes"))
if not attributes:
raise Exception("attributes is required (name=value;name2=value2)")
body = {
"attributes": attributes,
"source": str(inputs.get("source") or "ServiceNow"),
}
inbound = parse_relations(inputs.get("inbound_relations"))
if inbound is not None:
body["inbound_relations"] = inbound
outbound = parse_relations(inputs.get("outbound_relations"))
if outbound is not None:
body["outbound_relations"] = outbound
path = "/cmdb/instance/" + urllib.parse.quote(ci_class)
print(json.dumps(request("POST", path, params=relation_params(inputs), body=body)))
try:
main()
except urllib.error.HTTPError as e:
print(json.dumps({"error": "HTTP " + str(e.code), "detail": e.read().decode("utf-8", "replace")}))
sys.exit(1)
except Exception as e:
print(json.dumps({"error": str(e)}))
sys.exit(1)
@@ -0,0 +1,81 @@
import base64, json, os, sys, urllib.parse, urllib.request, urllib.error
def _cfg():
return json.loads(os.environ.get("INTEGRATION_SECRETS", "{}"))
def _headers(cfg):
h = {"Accept": "application/json", "Content-Type": "application/json"}
if str(cfg.get("auth_type") or "basic").lower() == "oauth":
data = urllib.parse.urlencode({
"grant_type": "password",
"client_id": cfg.get("client_id", ""),
"client_secret": cfg.get("client_secret", ""),
"username": cfg.get("username", ""),
"password": cfg.get("password", ""),
}).encode("utf-8")
req = urllib.request.Request(
cfg.get("url", "").rstrip("/") + "/oauth_token.do", data=data,
headers={"Content-Type": "application/x-www-form-urlencoded", "Accept": "application/json"}, method="POST")
with urllib.request.urlopen(req, timeout=60) as r:
tok = json.loads(r.read())
if not tok.get("access_token"):
raise Exception("OAuth token request failed: " + json.dumps(tok))
h["Authorization"] = "Bearer " + tok["access_token"]
else:
cred = (cfg.get("username", "") + ":" + cfg.get("password", "")).encode("utf-8")
h["Authorization"] = "Basic " + base64.b64encode(cred).decode("ascii")
return h
def request(method, path, params=None, body=None, root="/api/now", versioned=True):
cfg = _cfg()
v = str(cfg.get("api_version") or "").strip().strip("/")
url = cfg.get("url", "").rstrip("/") + root + ("/" + v if v and versioned else "") + path
q = {k: str(x) for k, x in (params or {}).items() if x not in (None, "")}
if q:
url += "?" + urllib.parse.urlencode(q)
data = json.dumps(body).encode("utf-8") if body is not None else None
req = urllib.request.Request(url, data=data, headers=_headers(cfg), method=method)
with urllib.request.urlopen(req, timeout=90) as r:
raw = r.read()
return json.loads(raw) if raw else {}
def relation_params(inputs):
fields = str(inputs.get("fields") or "")
if fields:
parts = [p.strip() for p in fields.split(",") if p.strip()]
for required in ("sys_id", "name"):
if required not in parts:
parts.append(required)
fields = ",".join(parts)
return {
"sysparm_fields": fields or None,
"sysparm_relation_limit": int(inputs.get("relation_limit") or 50),
"sysparm_relation_offset": int(inputs.get("relation_offset") or 0),
}
def main():
inputs = json.loads(os.environ.get("INTEGRATION_INPUTS", "{}"))
ci_class = str(inputs.get("class") or "")
sys_id = str(inputs.get("sys_id") or "")
rel_sys_id = str(inputs.get("relation_sys_id") or "")
if not ci_class or not sys_id or not rel_sys_id:
raise Exception("class, sys_id and relation_sys_id are required")
path = ("/cmdb/instance/" + urllib.parse.quote(ci_class) + "/" + urllib.parse.quote(sys_id)
+ "/relation/" + urllib.parse.quote(rel_sys_id))
res = request("DELETE", path, params=relation_params(inputs))
print(json.dumps(res if res else {"ok": True, "relation_sys_id": rel_sys_id}))
try:
main()
except urllib.error.HTTPError as e:
print(json.dumps({"error": "HTTP " + str(e.code), "detail": e.read().decode("utf-8", "replace")}))
sys.exit(1)
except Exception as e:
print(json.dumps({"error": str(e)}))
sys.exit(1)
@@ -0,0 +1,78 @@
import base64, json, os, sys, urllib.parse, urllib.request, urllib.error
def _cfg():
return json.loads(os.environ.get("INTEGRATION_SECRETS", "{}"))
def _headers(cfg):
h = {"Accept": "application/json", "Content-Type": "application/json"}
if str(cfg.get("auth_type") or "basic").lower() == "oauth":
data = urllib.parse.urlencode({
"grant_type": "password",
"client_id": cfg.get("client_id", ""),
"client_secret": cfg.get("client_secret", ""),
"username": cfg.get("username", ""),
"password": cfg.get("password", ""),
}).encode("utf-8")
req = urllib.request.Request(
cfg.get("url", "").rstrip("/") + "/oauth_token.do", data=data,
headers={"Content-Type": "application/x-www-form-urlencoded", "Accept": "application/json"}, method="POST")
with urllib.request.urlopen(req, timeout=60) as r:
tok = json.loads(r.read())
if not tok.get("access_token"):
raise Exception("OAuth token request failed: " + json.dumps(tok))
h["Authorization"] = "Bearer " + tok["access_token"]
else:
cred = (cfg.get("username", "") + ":" + cfg.get("password", "")).encode("utf-8")
h["Authorization"] = "Basic " + base64.b64encode(cred).decode("ascii")
return h
def request(method, path, params=None, body=None, root="/api/now", versioned=True):
cfg = _cfg()
v = str(cfg.get("api_version") or "").strip().strip("/")
url = cfg.get("url", "").rstrip("/") + root + ("/" + v if v and versioned else "") + path
q = {k: str(x) for k, x in (params or {}).items() if x not in (None, "")}
if q:
url += "?" + urllib.parse.urlencode(q)
data = json.dumps(body).encode("utf-8") if body is not None else None
req = urllib.request.Request(url, data=data, headers=_headers(cfg), method=method)
with urllib.request.urlopen(req, timeout=90) as r:
raw = r.read()
return json.loads(raw) if raw else {}
def relation_params(inputs):
fields = str(inputs.get("fields") or "")
if fields:
parts = [p.strip() for p in fields.split(",") if p.strip()]
for required in ("sys_id", "name"):
if required not in parts:
parts.append(required)
fields = ",".join(parts)
return {
"sysparm_fields": fields or None,
"sysparm_relation_limit": int(inputs.get("relation_limit") or 50),
"sysparm_relation_offset": int(inputs.get("relation_offset") or 0),
}
def main():
inputs = json.loads(os.environ.get("INTEGRATION_INPUTS", "{}"))
ci_class = str(inputs.get("class") or "")
sys_id = str(inputs.get("sys_id") or "")
if not ci_class or not sys_id:
raise Exception("class and sys_id are required")
path = "/cmdb/instance/" + urllib.parse.quote(ci_class) + "/" + urllib.parse.quote(sys_id)
print(json.dumps(request("GET", path, params=relation_params(inputs))))
try:
main()
except urllib.error.HTTPError as e:
print(json.dumps({"error": "HTTP " + str(e.code), "detail": e.read().decode("utf-8", "replace")}))
sys.exit(1)
except Exception as e:
print(json.dumps({"error": str(e)}))
sys.exit(1)
@@ -0,0 +1,65 @@
import base64, json, os, sys, urllib.parse, urllib.request, urllib.error
def _cfg():
return json.loads(os.environ.get("INTEGRATION_SECRETS", "{}"))
def _headers(cfg):
h = {"Accept": "application/json", "Content-Type": "application/json"}
if str(cfg.get("auth_type") or "basic").lower() == "oauth":
data = urllib.parse.urlencode({
"grant_type": "password",
"client_id": cfg.get("client_id", ""),
"client_secret": cfg.get("client_secret", ""),
"username": cfg.get("username", ""),
"password": cfg.get("password", ""),
}).encode("utf-8")
req = urllib.request.Request(
cfg.get("url", "").rstrip("/") + "/oauth_token.do", data=data,
headers={"Content-Type": "application/x-www-form-urlencoded", "Accept": "application/json"}, method="POST")
with urllib.request.urlopen(req, timeout=60) as r:
tok = json.loads(r.read())
if not tok.get("access_token"):
raise Exception("OAuth token request failed: " + json.dumps(tok))
h["Authorization"] = "Bearer " + tok["access_token"]
else:
cred = (cfg.get("username", "") + ":" + cfg.get("password", "")).encode("utf-8")
h["Authorization"] = "Basic " + base64.b64encode(cred).decode("ascii")
return h
def request(method, path, params=None, body=None, root="/api/now", versioned=True):
cfg = _cfg()
v = str(cfg.get("api_version") or "").strip().strip("/")
url = cfg.get("url", "").rstrip("/") + root + ("/" + v if v and versioned else "") + path
q = {k: str(x) for k, x in (params or {}).items() if x not in (None, "")}
if q:
url += "?" + urllib.parse.urlencode(q)
data = json.dumps(body).encode("utf-8") if body is not None else None
req = urllib.request.Request(url, data=data, headers=_headers(cfg), method=method)
with urllib.request.urlopen(req, timeout=90) as r:
raw = r.read()
return json.loads(raw) if raw else {}
def main():
inputs = json.loads(os.environ.get("INTEGRATION_INPUTS", "{}"))
ci_class = str(inputs.get("class") or "")
if not ci_class:
raise Exception("class is required")
print(json.dumps(request("GET", "/cmdb/instance/" + urllib.parse.quote(ci_class), params={
"sysparm_query": inputs.get("query"),
"sysparm_limit": int(inputs.get("limit") or 50),
"sysparm_offset": int(inputs.get("offset") or 0),
})))
try:
main()
except urllib.error.HTTPError as e:
print(json.dumps({"error": "HTTP " + str(e.code), "detail": e.read().decode("utf-8", "replace")}))
sys.exit(1)
except Exception as e:
print(json.dumps({"error": str(e)}))
sys.exit(1)
@@ -0,0 +1,62 @@
import base64, json, os, sys, urllib.parse, urllib.request, urllib.error
def _cfg():
return json.loads(os.environ.get("INTEGRATION_SECRETS", "{}"))
def _headers(cfg):
h = {"Accept": "application/json", "Content-Type": "application/json"}
if str(cfg.get("auth_type") or "basic").lower() == "oauth":
data = urllib.parse.urlencode({
"grant_type": "password",
"client_id": cfg.get("client_id", ""),
"client_secret": cfg.get("client_secret", ""),
"username": cfg.get("username", ""),
"password": cfg.get("password", ""),
}).encode("utf-8")
req = urllib.request.Request(
cfg.get("url", "").rstrip("/") + "/oauth_token.do", data=data,
headers={"Content-Type": "application/x-www-form-urlencoded", "Accept": "application/json"}, method="POST")
with urllib.request.urlopen(req, timeout=60) as r:
tok = json.loads(r.read())
if not tok.get("access_token"):
raise Exception("OAuth token request failed: " + json.dumps(tok))
h["Authorization"] = "Bearer " + tok["access_token"]
else:
cred = (cfg.get("username", "") + ":" + cfg.get("password", "")).encode("utf-8")
h["Authorization"] = "Basic " + base64.b64encode(cred).decode("ascii")
return h
def request(method, path, params=None, body=None, root="/api/now", versioned=True):
cfg = _cfg()
v = str(cfg.get("api_version") or "").strip().strip("/")
url = cfg.get("url", "").rstrip("/") + root + ("/" + v if v and versioned else "") + path
q = {k: str(x) for k, x in (params or {}).items() if x not in (None, "")}
if q:
url += "?" + urllib.parse.urlencode(q)
data = json.dumps(body).encode("utf-8") if body is not None else None
req = urllib.request.Request(url, data=data, headers=_headers(cfg), method=method)
with urllib.request.urlopen(req, timeout=90) as r:
raw = r.read()
return json.loads(raw) if raw else {}
def main():
cfg = _cfg()
ci_class = str(cfg.get("test_class") or "cmdb_ci_computer")
res = request("GET", "/cmdb/instance/" + urllib.parse.quote(ci_class), params={"sysparm_limit": 1})
if "result" not in res:
raise Exception("Unexpected response: " + json.dumps(res))
print(json.dumps({"ok": True, "class": ci_class}))
try:
main()
except urllib.error.HTTPError as e:
print(json.dumps({"error": "HTTP " + str(e.code), "detail": e.read().decode("utf-8", "replace")}))
sys.exit(1)
except Exception as e:
print(json.dumps({"error": str(e)}))
sys.exit(1)
@@ -0,0 +1,97 @@
import base64, json, os, sys, urllib.parse, urllib.request, urllib.error
def _cfg():
return json.loads(os.environ.get("INTEGRATION_SECRETS", "{}"))
def _headers(cfg):
h = {"Accept": "application/json", "Content-Type": "application/json"}
if str(cfg.get("auth_type") or "basic").lower() == "oauth":
data = urllib.parse.urlencode({
"grant_type": "password",
"client_id": cfg.get("client_id", ""),
"client_secret": cfg.get("client_secret", ""),
"username": cfg.get("username", ""),
"password": cfg.get("password", ""),
}).encode("utf-8")
req = urllib.request.Request(
cfg.get("url", "").rstrip("/") + "/oauth_token.do", data=data,
headers={"Content-Type": "application/x-www-form-urlencoded", "Accept": "application/json"}, method="POST")
with urllib.request.urlopen(req, timeout=60) as r:
tok = json.loads(r.read())
if not tok.get("access_token"):
raise Exception("OAuth token request failed: " + json.dumps(tok))
h["Authorization"] = "Bearer " + tok["access_token"]
else:
cred = (cfg.get("username", "") + ":" + cfg.get("password", "")).encode("utf-8")
h["Authorization"] = "Basic " + base64.b64encode(cred).decode("ascii")
return h
def request(method, path, params=None, body=None, root="/api/now", versioned=True):
cfg = _cfg()
v = str(cfg.get("api_version") or "").strip().strip("/")
url = cfg.get("url", "").rstrip("/") + root + ("/" + v if v and versioned else "") + path
q = {k: str(x) for k, x in (params or {}).items() if x not in (None, "")}
if q:
url += "?" + urllib.parse.urlencode(q)
data = json.dumps(body).encode("utf-8") if body is not None else None
req = urllib.request.Request(url, data=data, headers=_headers(cfg), method=method)
with urllib.request.urlopen(req, timeout=90) as r:
raw = r.read()
return json.loads(raw) if raw else {}
def relation_params(inputs):
fields = str(inputs.get("fields") or "")
if fields:
parts = [p.strip() for p in fields.split(",") if p.strip()]
for required in ("sys_id", "name"):
if required not in parts:
parts.append(required)
fields = ",".join(parts)
return {
"sysparm_fields": fields or None,
"sysparm_relation_limit": int(inputs.get("relation_limit") or 50),
"sysparm_relation_offset": int(inputs.get("relation_offset") or 0),
}
def split_attrs(s):
out = {}
for part in str(s or "").split(";"):
if "=" not in part:
continue
k, v = part.split("=", 1)
k = k.strip()
if k:
out[k] = v
return out
def main():
inputs = json.loads(os.environ.get("INTEGRATION_INPUTS", "{}"))
ci_class = str(inputs.get("class") or "")
sys_id = str(inputs.get("sys_id") or "")
if not ci_class or not sys_id:
raise Exception("class and sys_id are required")
attributes = split_attrs(inputs.get("attributes"))
if not attributes:
raise Exception("attributes is required (name=value;name2=value2)")
body = {
"attributes": attributes,
"source": str(inputs.get("source") or "ServiceNow"),
}
path = "/cmdb/instance/" + urllib.parse.quote(ci_class) + "/" + urllib.parse.quote(sys_id)
print(json.dumps(request("PATCH", path, params=relation_params(inputs), body=body)))
try:
main()
except urllib.error.HTTPError as e:
print(json.dumps({"error": "HTTP " + str(e.code), "detail": e.read().decode("utf-8", "replace")}))
sys.exit(1)
except Exception as e:
print(json.dumps({"error": str(e)}))
sys.exit(1)