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

eramba

package module
v0.9.0 Latest Latest
Warning

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

Go to latest
Published: Mar 30, 2026 License: MIT Imports: 11 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
Assets Get, Index, Patch, Post, Delete
Asset Reviews Index
Groups Get, Index
Users Get, Index
Security Policies Get, Index, Patch, Post
Security Policy Reviews Get, Index, Patch, Post, Delete
Projects Index, Patch, Post Supported Comments
Project Comments Post
Risk Exceptions Get, Index, Patch, Post
Risks Get, Index, Patch, Post Supported Comments
Risk Reviews Index, Patch, Post
Risk Threats Get, Index
Security Services Get, Index, Patch Comments
Security Service Comments Index
Third Parties Get, Index, Patch Supported
Third Party Risks Get, Index, Patch, Post Supported
Third Party Risk Reviews Index, Post

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) BaseUrl

func (a *Client) BaseUrl() string

func (*Client) DeleteAsset

func (a *Client) DeleteAsset(ctx context.Context, id int32) error

func (*Client) DeleteSecurityPolicyReview added in v0.4.2

func (a *Client) DeleteSecurityPolicyReview(ctx context.Context, id int32) error

func (*Client) GetAsset

func (a *Client) GetAsset(ctx context.Context, id int32) (model.Asset, error)

func (*Client) GetAssetReviews

func (a *Client) GetAssetReviews(ctx context.Context) ([]model.Review, error)

func (*Client) GetAssets

func (a *Client) GetAssets(ctx context.Context) ([]model.Asset, error)

func (*Client) GetGroup added in v0.2.3

func (a *Client) GetGroup(ctx context.Context, id int32) (model.Group, error)

func (*Client) GetGroups added in v0.2.3

func (a *Client) GetGroups(ctx context.Context) ([]model.Group, error)

func (*Client) GetProjects

func (a *Client) GetProjects(ctx context.Context) ([]model.Project, error)

func (*Client) GetRisk

func (a *Client) GetRisk(ctx context.Context, id int32) (model.Risk, error)

func (*Client) GetRiskException

func (a *Client) GetRiskException(ctx context.Context, id int32) (model.RiskException, error)

func (*Client) GetRiskExceptions

func (a *Client) GetRiskExceptions(ctx context.Context) ([]model.RiskException, error)

func (*Client) GetRiskReviews

func (a *Client) GetRiskReviews(ctx context.Context) ([]model.Review, error)

func (*Client) GetRiskThreat

func (a *Client) GetRiskThreat(ctx context.Context, id int32) (model.RiskThreat, error)

func (*Client) GetRiskThreats

func (a *Client) GetRiskThreats(ctx context.Context) ([]model.RiskThreat, error)

func (*Client) GetRisks

func (a *Client) GetRisks(ctx context.Context) ([]model.Risk, error)

func (*Client) GetSecurityPolicies

func (a *Client) GetSecurityPolicies(ctx context.Context) ([]model.SecurityPolicy, error)

func (*Client) GetSecurityPolicy added in v0.4.3

func (a *Client) GetSecurityPolicy(ctx context.Context, id int32) (model.SecurityPolicy, error)

func (*Client) GetSecurityPolicyReview added in v0.4.2

func (a *Client) GetSecurityPolicyReview(ctx context.Context, id int32) (model.SecurityPolicyReview, error)

func (*Client) GetSecurityPolicyReviews

func (a *Client) GetSecurityPolicyReviews(ctx context.Context) ([]model.SecurityPolicyReview, error)

func (*Client) GetSecurityService

func (a *Client) GetSecurityService(ctx context.Context, id int32) (model.SecurityService, error)

func (*Client) GetSecurityServices

func (a *Client) GetSecurityServices(ctx context.Context) ([]model.SecurityService, error)

func (*Client) GetThirdParties added in v0.5.0

func (a *Client) GetThirdParties(ctx context.Context) ([]model.ThirdParty, error)

func (*Client) GetThirdParty added in v0.5.0

func (a *Client) GetThirdParty(ctx context.Context, id int32) (model.ThirdParty, error)

func (*Client) GetThirdPartyRisk

func (a *Client) GetThirdPartyRisk(ctx context.Context, id int32) (model.ThirdPartyRisk, error)

func (*Client) GetThirdPartyRiskReviews

func (a *Client) GetThirdPartyRiskReviews(ctx context.Context) ([]model.Review, error)

func (*Client) GetThirdPartyRisks

func (a *Client) GetThirdPartyRisks(ctx context.Context) ([]model.ThirdPartyRisk, error)

func (*Client) GetUser added in v0.2.3

func (a *Client) GetUser(ctx context.Context, id int32) (model.User, error)

func (*Client) GetUsers added in v0.2.3

func (a *Client) GetUsers(ctx context.Context) ([]model.User, error)

func (*Client) PatchAsset

func (a *Client) PatchAsset(ctx context.Context, id int32, data *model.Asset) (*model.Asset, error)

func (*Client) PatchProject

func (a *Client) PatchProject(ctx context.Context, id int32, data *model.Project) (*model.Project, error)

func (*Client) PatchRisk

func (a *Client) PatchRisk(ctx context.Context, id int32, data *model.Risk) (*model.Risk, error)

func (*Client) PatchRiskException

func (a *Client) PatchRiskException(
	ctx context.Context,
	id int32,
	data *model.RiskException,
) (*model.RiskException, error)

func (*Client) PatchRiskReview

func (a *Client) PatchRiskReview(ctx context.Context, id int32, data *model.Review) (*model.Review, error)

func (*Client) PatchSecurityPolicy

func (a *Client) PatchSecurityPolicy(
	ctx context.Context,
	id int32,
	data *model.SecurityPolicy,
) (*model.SecurityPolicy, error)

func (*Client) PatchSecurityPolicyReview

func (a *Client) PatchSecurityPolicyReview(
	ctx context.Context,
	id int32,
	data *model.SecurityPolicyReview,
) (*model.SecurityPolicyReview, error)

func (*Client) PatchSecurityService

func (a *Client) PatchSecurityService(
	ctx context.Context,
	id int32,
	data *model.SecurityService,
) (*model.SecurityService, error)

func (*Client) PatchThirdParty added in v0.7.0

func (a *Client) PatchThirdParty(
	ctx context.Context,
	id int32,
	data *model.ThirdParty,
) (*model.ThirdParty, error)

func (*Client) PatchThirdPartyRisk

func (a *Client) PatchThirdPartyRisk(
	ctx context.Context,
	id int32,
	data *model.ThirdPartyRisk,
) (*model.ThirdPartyRisk, error)

func (*Client) PostAsset

func (a *Client) PostAsset(ctx context.Context, data *model.Asset) (*model.Asset, error)

func (*Client) PostProject

func (a *Client) PostProject(ctx context.Context, data *model.Project) (*model.Project, error)

func (*Client) PostRisk

func (a *Client) PostRisk(ctx context.Context, data *model.Risk) (*model.Risk, error)

func (*Client) PostRiskException

func (a *Client) PostRiskException(ctx context.Context, data *model.RiskException) (*model.RiskException, error)

func (*Client) PostRiskReview

func (a *Client) PostRiskReview(ctx context.Context, data *model.Review) (*model.Review, error)

func (*Client) PostSecurityPolicy added in v0.4.1

func (a *Client) PostSecurityPolicy(
	ctx context.Context,
	data *model.SecurityPolicy,
) (*model.SecurityPolicy, error)

func (*Client) PostSecurityPolicyReview

func (a *Client) PostSecurityPolicyReview(
	ctx context.Context,
	data *model.SecurityPolicyReview,
) (*model.SecurityPolicyReview, error)

func (*Client) PostThirdPartyRisk added in v0.7.1

func (a *Client) PostThirdPartyRisk(ctx context.Context, data *model.ThirdPartyRisk) (*model.ThirdPartyRisk, error)

func (*Client) PostThirdPartyRiskReview

func (a *Client) PostThirdPartyRiskReview(ctx context.Context, data *model.Review) (*model.Review, error)

func (*Client) ProjectComments added in v0.9.0

func (a *Client) ProjectComments() *CommentsClient

func (*Client) RiskComments added in v0.9.0

func (a *Client) RiskComments() *CommentsClient

func (*Client) SecurityServiceComments added in v0.9.0

func (a *Client) SecurityServiceComments() *CommentsClient

func (*Client) ThirdPartyRiskComments added in v0.9.0

func (a *Client) ThirdPartyRiskComments() *CommentsClient

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 Pagination

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

Directories

Path Synopsis
examples
basic command
comments command
custom_fields command
thirdparty command
users command

Jump to

Keyboard shortcuts

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