go-hsdp-api

module
v0.85.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 26, 2024 License: MIT

README

Maintainability PkgGoDev

go-hsdp-api

A HSDP API client library enabling Go programs to interact with various HSDP APIs in a simple and uniform way

[!Important] This library is not endorsed, supported or approved by HSDP. It is a Philips Open Source community managed project. Please do not raise SNOW tickets, instead open a issue on the Github project.

Supported APIs

The current implement covers only a subset of HSDP APIs. Basically, we implement functionality as needed.

  • Cartel c.q. Container Host management (examples)
  • Clinical Data Repository (CDR)
    • Tenant Onboarding
    • Subscription management
    • FHIR CRUD
    • FHIR Patch
    • STU3
    • R4
  • Connect IoT
    • Master Data Management (MDM)
      • Propositions
      • Applications
      • Data Adapter
      • Data Subscribers
      • OAuth2 clients
      • Standard Services
      • Service Actions
      • Service References
      • Storage Classes
      • Device Groups
      • Device Types
      • Regions
      • Buckets
      • Data Types
      • Blob Data Contracts
      • Blob Subscriptions
      • Data Broker Subscriptions
      • Firmware Components
      • Firmware Component Versions
      • OAuth Client Scopes
      • Subscriber Types
      • Resources Limits
      • Authentication Methods
    • Data Broker
      • Data Items
      • Subscribers
        • SQS
        • Kinesis
      • Subscriptions
      • Access Details
    • Blob Repository
      • Blob Metadata
      • Access Policy
      • Access URL
      • Multipart Upload
      • BlobStore Policy management
      • Topic management
      • Store Access
      • Bucket management
      • Contract management
      • Subscription management
  • Secure Transport Layer (STL) / Edge
    • Device queries
    • Application Resources management
    • Device configuration management (firewall, logging)
  • Public Key Infrastructure (PKI) management
  • Identity and Access Management (IAM)
    • Groups
    • Organizations
    • Permissions
    • Roles
    • Role Sharing Policies
    • Users
    • Passwords
    • Propositions
    • Applications
    • Services
    • Devices
    • MFA Policies
    • Password Policies
    • Email Templates
    • SMS Gateways
    • SMS Templates
  • Logging (examples)
  • Auditing (examples)
  • Telemetry Data Repository (TDR)
    • Contract management
    • Data Item management
  • S3Creds Policy management
  • DICOM Store
    • Config management
  • Notification service
  • Service Discovery
  • Console settings
    • Metrics Alerts
    • Metrics Autoscalers
  • Docker Registry
    • Service Keys management
    • Namespace management
    • Repository management
  • IronIO tasks, codes and schedules management (examples)
  • Clinical Data Lake (CDL) management
    • Research Studies
    • Data Type Definitions
    • Label Definitions
    • Export Routes
  • AI Inference
    • Compute Environment management
    • Compute Target managements
    • Model management
    • Inference Job management
  • AI Training
    • Compute Environment management
    • Model management
  • AI Workspace
    • Compute Target management
    • Workspace management

Example usage

package main

import (
        "fmt"

        "github.com/philips-software/go-hsdp-api/iam"
)

func main() {
        client, _ := iam.NewClient(nil, &iam.Config{
                Region:         "us-east",
                Environment:    "client-test",
                OAuth2ClientID: "ClientID",
                OAuth2Secret:   "ClientPWD",
        })
        err := client.Login("iam.login@hospital1.com", "Password!@#")
        if err != nil {
                fmt.Printf("Error logging in: %v\n", err)
                return
        }
        introspect, _, _ := client.Introspect()
        if introspect != nil {
                fmt.Printf("Introspect response: %v\n", introspect)
        }
}

TODO

  • Increase API coverage

Issues

Contact / Getting help

Andy Lo-A-Foe (andy.lo-a-foe@philips.com)

License

License is MIT. See LICENSE file

Directories

Path Synopsis
ai
Package ai provides support the HSDP AI services
Package ai provides support the HSDP AI services
Package audit provides support for interacting with the HSDP Audit service
Package audit provides support for interacting with the HSDP Audit service
helper/fhir/dstu2
Package dstu2 contains helper methods to construct AuditEvent resources
Package dstu2 contains helper methods to construct AuditEvent resources
Package cartel provides support for HSDP Cartel services
Package cartel provides support for HSDP Cartel services
Package cdl provides support for interacting with HSDP Clinical Data Lake services
Package cdl provides support for interacting with HSDP Clinical Data Lake services
cdr
Package cdr provides support for HSDP CDR services
Package cdr provides support for HSDP CDR services
helper/fhir/r4
Package r4 contains helper methods for use with CDR
Package r4 contains helper methods for use with CDR
helper/fhir/stu3
Package stu3 contains helper methods for use with CDR
Package stu3 contains helper methods for use with CDR
Package world provides info on HSDP services
Package world provides info on HSDP services
connect
blr
Package blr provides support the HSDP Blob Repository services
Package blr provides support the HSDP Blob Repository services
dbs
Package dbs provides support the HSDP Data Broker services
Package dbs provides support the HSDP Data Broker services
mdm
Package mdm provides support the HSDP Connect IoT services
Package mdm provides support the HSDP Connect IoT services
Package console provides support for HSDP Console APIs
Package console provides support for HSDP Console APIs
docker
Package docker provides support for HSDP Docker Registry services
Package docker provides support for HSDP Docker Registry services
Package dicom provides support for HSDP DICOM services
Package dicom provides support for HSDP DICOM services
Package discovery provides support the HSDP Discovery services
Package discovery provides support the HSDP Discovery services
Package iam provides support for interacting with HSDP IAM and IDM services
Package iam provides support for interacting with HSDP IAM and IDM services
Package iron provides support for HSDP Iron services
Package iron provides support for HSDP Iron services
Package logging provides support for HSDP Logging services
Package logging provides support for HSDP Logging services
Package notification provides support for interacting with HSDP Notification services
Package notification provides support for interacting with HSDP Notification services
Package pki provides support for HSDP PKI service
Package pki provides support for HSDP PKI service
Package s3creds provides support for HSDP S3 Credentials
Package s3creds provides support for HSDP S3 Credentials
Package stl provides support for HSDP STL services
Package stl provides support for HSDP STL services
Package tdr provides support for HSDP TDR operations
Package tdr provides support for HSDP TDR operations

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL