auxo

package module
v1.0.10 Latest Latest
Warning

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

Go to latest
Published: Apr 16, 2024 License: MIT Imports: 4 Imported by: 1

README

Go Reference

Introduction

This repository contains an AUXO API wrapper in GO.

AUXO API documentation: https://api.on2it.net/v3/doc

Versions

Check the tags for the most current version.

Using the Auxo API wrapper

Requirements
  • Address of the AUXO portal (API)
  • Security token
Go MOD

When using modules, initiate your (new) project;

go mod init github.com/projectname

Add the API module to go.mod, it is recommended to specificly specify the version

module github.com/projectname

go 1.19

require (
   github.com/on2itsecurity/go-auxo v1.0.10
)

Download the package.

go mod vendor

Adding the package to your project

  1. Include the library in your projects in the Import.

    import (
    	"github.com/on2itsecurity/go-auxo"
    )
    
  2. Create the APIClient object with Token and Address to connect to.

     auxoClient := auxo.NewClient(address, token, debug)
    
  3. Call the functions, i.e.

    allProtectSurfaces, err := auxoClient.ZeroTrust.GetProtectSurfaces()
    
Structure

The aim is to support all Auxo API endpoints, currently;

  • Asset
  • CRM
  • Eventflow
  • ZeroTrust
  • ZTReadiness

These different endpoints can be called with the same client, i.e.;

auxoClient.Asset.<action>
auxoClient.CRM.<action>
auxoClient.Eventflow.<action>
auxoClient.ZeroTrust.<action>
auxoClient.ZTReadiness.<action>

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

type Client struct {
	Asset     *asset.Asset
	CRM       *crm.CRM
	EventFlow *eventflow.EventFlow
	ZeroTrust *zerotrust.ZeroTrust
}

Client struct, contains the different "Auxo API sections"

func NewClient

func NewClient(address, token string, debug bool) (*Client, error)

NewClient constructor returns a client which can be used to make the calls. returns *client, error

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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