scc-go-sdk

module
v1.3.4 Latest Latest
Warning

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

Go to latest
Published: Nov 29, 2021 License: Apache-2.0

README

CI/CD Pipeline Release Go Reference GitHub go.mod Go version License codecov semantic-release

IBM Cloud Security & Compliance Center Go SDK Version v1.3.4

Go client library to interact with various IBM Cloud Security & Compliance Center APIs.

Table of Contents

Overview

The IBM Cloud Security & Compliance Center Go SDK allows developers to programmatically interact with the following IBM Cloud services:

Service Name Package name
Findings findingsv1
Notifications notificationsv1
Configuration Governance configurationgovernancev1
Admin Service adminserviceapiv1
Posture Management posturemanagementv1

Prerequisites

  • An IBM Cloud account.
  • An IAM API key to allow the SDK to access your account. Create one here.
  • Go version 1.12 or above.

Installation

The current version of this SDK: v1.3.4

Go modules

If your application uses Go modules for dependency management (recommended), just add an import for each service that you will use in your application.
Here is an example:

import (
	"github.com/IBM/scc-go-sdk/findingsv1"
)

Next, run go build or go mod tidy to download and install the new dependencies and update your application's go.mod file.

In the example above, the findingsv1 part of the import path is the package name associated with the Findings service. See the service table above to find the appropriate package name for the services used by your application.

go get command

Alternatively, you can use the go get command to download and install the appropriate packages needed by your application:

go get -u github.com/IBM/scc-go-sdk/findingsv1

Be sure to use the appropriate package name from the service table above for the services used by your application.

Using the SDK

For general SDK usage information, please see this link

Questions

If you are having difficulties using this SDK or have a question about the IBM Cloud services, please ask a question at Stack Overflow.

Issues

If you encounter an issue with the project, you are welcome to submit a bug report. Before that, please search for similar issues. It's possible that someone has already reported the problem.

Open source @ IBM

Find more open source projects on the IBM Github Page

Contributing

See CONTRIBUTING.

License

The IBM Cloud Security & Compliance Center Go SDK is released under the Apache 2.0 license. The license's full text can be found in LICENSE.

Directories

Path Synopsis
Package adminserviceapiv1 : Operations and models for the AdminServiceApiV1 service
Package adminserviceapiv1 : Operations and models for the AdminServiceApiV1 service
Package configurationgovernancev1 : Operations and models for the ConfigurationGovernanceV1 service
Package configurationgovernancev1 : Operations and models for the ConfigurationGovernanceV1 service
Package findingsv1 : Operations and models for the FindingsV1 service
Package findingsv1 : Operations and models for the FindingsV1 service
Package notificationsv1 : Operations and models for the NotificationsV1 service
Package notificationsv1 : Operations and models for the NotificationsV1 service
Package posturemanagementv1 : Operations and models for the PostureManagementV1 service
Package posturemanagementv1 : Operations and models for the PostureManagementV1 service
Package posturemanagementv2 : Operations and models for the PostureManagementV2 service
Package posturemanagementv2 : Operations and models for the PostureManagementV2 service

Jump to

Keyboard shortcuts

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