Help us shape the future of Go! Take the 2026 Go Developer Survey

eramba

package module
v0.18.2 Latest Latest
Warning

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

 Go to latest Published: Oct 7, 2026 License: MIT Imports: 10 Imported by: 0

README

eramba go client

[!IMPORTANT] This is a early version not all API's are supported and tested.

Supported Eramba Instance

Minimal requirement is Eramba 3.28.0.

Supported APIs

Type Methods Custom Fields Comments & Attachments Reviews
Assets Get, Index, Patch, Post, Delete Comments Supported
Groups (v2) Get, Index, Post, Put, Delete
Users (v2) Get, Index, Post, Put, Delete
Security Policies Get, Index, Patch, Post, Delete
Security Policy Reviews Get, Index, Patch, Post, Delete
Projects Get, Index, Patch, Post, Delete Supported Comments
Risk Exceptions Get, Index, Patch, Post, Delete
Risks Get, Index, Patch, Post, Delete Supported Comments Supported
Risk Threats Get, Index
Security Services Get, Index, Patch, Post, Delete Comments
Third Parties Get, Index, Patch, Post, Delete Supported
Third Party Risks Get, Index, Patch, Post, Delete Supported Comments Supported
BusinessContinuity Get, Index, Patch, Post, Delete Supported Comments Supported

Disclaimer

This project is not associated with Eramba LTD.

Documentation

Index

Constants

View Source 
const (
	PageSize              = 200
	DefaultTimeoutSeconds = 30
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

type Client struct {
	// contains filtered or unexported fields
}

func New 

func New(erambaUrl, username, password string) Client

func (*Client) Assets added in v0.15.0 

func (a *Client) Assets() *GetAndPatchClientWithCommentAndReview[model.Asset]

func (*Client) BaseUrl 

func (a *Client) BaseUrl() string

func (*Client) BusinessContinuities added in v0.15.0 

func (a *Client) BusinessContinuities() *GetAndPatchClientWithCommentAndReview[model.BusinessContinuity]

func (*Client) Groups added in v0.15.0 

func (a *Client) Groups() *ReadWriteClientV2[model.Group]

func (*Client) Projects added in v0.15.0 

func (a *Client) Projects() *GetAndPatchClientWithComment[model.Project]

func (*Client) RiskExceptions added in v0.15.0 

func (a *Client) RiskExceptions() *GetAndPatchClient[model.RiskException]

func (*Client) RiskThreats added in v0.15.0 

func (a *Client) RiskThreats() *GetClient[model.RiskThreat]

func (*Client) Risks added in v0.15.0 

func (a *Client) Risks() *GetAndPatchClientWithCommentAndReview[model.Risk]

func (*Client) SecurityPolicies added in v0.15.0 

func (a *Client) SecurityPolicies() *GetAndPatchClient[model.SecurityPolicy]

func (*Client) SecurityPolicyReviews added in v0.15.0 

func (a *Client) SecurityPolicyReviews() *GetAndPatchClient[model.SecurityPolicyReview]

func (*Client) SecurityServices added in v0.15.0 

func (a *Client) SecurityServices() *GetAndPatchClientWithComment[model.SecurityService]

func (*Client) ThirdParties added in v0.15.0 

func (a *Client) ThirdParties() *GetAndPatchClient[model.ThirdParty]

func (*Client) ThirdPartyRisks added in v0.15.0 

func (a *Client) ThirdPartyRisks() *GetAndPatchClientWithCommentAndReview[model.ThirdPartyRisk]

func (*Client) Users added in v0.15.0 

func (a *Client) Users() *ReadWriteClientV2[model.User]

type CommentsClient added in v0.9.0 

type CommentsClient struct {
	// contains filtered or unexported fields
}

func (*CommentsClient) DeleteComment added in v0.9.0 

func (a *CommentsClient) DeleteComment(ctx context.Context, foreignKey, id int32) error

func (*CommentsClient) GetComment added in v0.9.0 

func (a *CommentsClient) GetComment(ctx context.Context, foreignKey, id int32) (model.Comment, error)

func (*CommentsClient) GetComments added in v0.9.0 

func (a *CommentsClient) GetComments(ctx context.Context, foreignKey int32) ([]model.Comment, error)

func (*CommentsClient) PostComment added in v0.9.0 

func (a *CommentsClient) PostComment(ctx context.Context, foreignKey int32, data *model.Comment) (*model.Comment, error)

type GetAndPatchClient added in v0.15.0 

type GetAndPatchClient[K any] struct {
	GetClient[K]
}

func (*GetAndPatchClient[K]) Delete added in v0.15.0 

func (a *GetAndPatchClient[K]) Delete(ctx context.Context, id int32) error

func (*GetAndPatchClient[K]) Patch added in v0.15.0 

func (a *GetAndPatchClient[K]) Patch(
	ctx context.Context,
	id int32,
	data *K,
) (*K, error)

func (*GetAndPatchClient[K]) Post added in v0.15.0 

func (a *GetAndPatchClient[K]) Post(ctx context.Context, data *K) (*K, error)

type GetAndPatchClientWithComment added in v0.15.0 

type GetAndPatchClientWithComment[K any] struct {
	GetAndPatchClient[K]
}

func (*GetAndPatchClientWithComment[K]) Comments added in v0.15.0 

func (a *GetAndPatchClientWithComment[K]) Comments() *CommentsClient

type GetAndPatchClientWithCommentAndReview added in v0.15.0 

type GetAndPatchClientWithCommentAndReview[K any] struct {
	GetAndPatchClientWithComment[K]
	// contains filtered or unexported fields
}

func (*GetAndPatchClientWithCommentAndReview[K]) Reviews added in v0.15.0 

func (a *GetAndPatchClientWithCommentAndReview[K]) Reviews() *ReviewsClient

type GetClient added in v0.15.0 

type GetClient[K any] struct {
	// contains filtered or unexported fields
}

func (*GetClient[K]) Get added in v0.15.0 

func (a *GetClient[K]) Get(ctx context.Context, id int32) (K, error)

func (*GetClient[K]) GetAll added in v0.15.0 

func (a *GetClient[K]) GetAll(ctx context.Context) ([]K, error)

type Pagination 

type Pagination struct {
	HasNextPage bool  `json:"has_next_page"`
	CurrentPage int32 `json:"current_page"`
}

type ReadWriteClientV2 added in v0.17.3 

type ReadWriteClientV2[K any] struct {
	GetClient[K]
}

func (*ReadWriteClientV2[K]) Delete added in v0.17.3 

func (a *ReadWriteClientV2[K]) Delete(ctx context.Context, id int32) error

func (*ReadWriteClientV2[K]) Post added in v0.17.3 

func (a *ReadWriteClientV2[K]) Post(ctx context.Context, data *K) (*K, error)

func (*ReadWriteClientV2[K]) Put added in v0.17.3 

func (a *ReadWriteClientV2[K]) Put(
	ctx context.Context,
	id int32,
	data *K,
) (*K, error)

type ReviewsClient added in v0.11.0 

type ReviewsClient struct {
	Model string
	GetAndPatchClient[model.Review]
}

Source Files

View all Source files

Directories

Path Synopsis
examples
basic command
comments command
risks command
users command
utils

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.