keyhub

package module
v1.3.5 Latest Latest
Warning

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

 Go to latest Published: Jun 28, 2024 License: Apache-2.0 Imports: 18 Imported by: 3

README

Build GitHub release (latest SemVer) License

go-keyhub - Topicus KeyHub API Client

[!CAUTION] DEPRECATED: please note that this package github.com/topicuskeyhub/go-keyhub has become deprecated in favor of github.com/topicuskeyhub/sdk-go

For more info see: https://github.com/topicuskeyhub/sdk-go/

How to use

See the examples directory for more complete examples.

go.mod:

require (
  github.com/topicuskeyhub/go-keyhub v1.3.2
)

import "github.com/topicuskeyhub/go-keyhub"

client, err := keyhub.NewClient(http.DefaultClient, issuer, clientid, clientsecret)
if err != nil {
    log.Fatalln("ERROR", err)
}
How to develop
  • Dependencies: go mod download
  • Code formatting: gofmt -s -w .

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccountService added in v1.0.0 

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

func (*AccountService) GetById added in v1.0.0 

func (s *AccountService) GetById(id int64) (result *model.Account, err error)

func (*AccountService) GetByUUID added in v1.0.0 

func (s *AccountService) GetByUUID(uuid uuid.UUID) (result *model.Account, err error)

func (*AccountService) List added in v1.0.0 

func (s *AccountService) List() (accounts []model.Account, err error)

type Client 

type Client struct {
	ID                 string
	Version            *VersionService
	Accounts           *AccountService
	Groups             *GroupService
	Systems            *SystemService
	ClientApplications *ClientApplicationService
	Vaults             *VaultService
	ServiceAccounts    *ServiceAccountService
	LaunchPadTile      *LaunchPadTileService
	VersionErrors      []error
}

func NewClient 

func NewClient(httpClient *http.Client, issuer string, clientID string, clientSecret string) (*Client, error)

func NewClientDefault added in v1.0.0 

func NewClientDefault(issuer string, clientID string, clientSecret string) (*Client, error)

type ClientApplicationService added in v1.2.0 

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

ClientApplicationService Service to manage client application configurations in keyhub

func (*ClientApplicationService) Create added in v1.2.0 

func (s *ClientApplicationService) Create(client *model.ClientApplication) (result *model.ClientApplication, err error)

Create a new client application in Keyhub

func (*ClientApplicationService) GetById added in v1.2.0 

func (s *ClientApplicationService) GetById(id int64) (result *model.ClientApplication, err error)

GetById Retrieve a client by keyhub id

func (*ClientApplicationService) GetByUUID added in v1.2.0 

func (s *ClientApplicationService) GetByUUID(uuid uuid.UUID) (result *model.ClientApplication, err error)

GetByUUID Retrieve a client by uuid

func (*ClientApplicationService) List added in v1.2.0 

func (s *ClientApplicationService) List() (clients []model.ClientApplication, err error)

List all available clients.

type GroupService 

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

func (*GroupService) Create added in v1.0.0 

func (s *GroupService) Create(group *model.Group) (result *model.Group, err error)

func (*GroupService) CreateMembership added in v1.1.0 

func (s *GroupService) CreateMembership(group *model.Group, list *model.GroupAccountList) (results *model.GroupAccountList, err error)

func (*GroupService) GetById added in v1.0.0 

func (s *GroupService) GetById(id int64) (result *model.Group, err error)

func (*GroupService) GetByUUID added in v1.0.0 

func (s *GroupService) GetByUUID(uuid uuid.UUID) (result *model.Group, err error)

func (*GroupService) List 

func (s *GroupService) List() (groups []model.Group, err error)

type LaunchPadTileService added in v1.3.1 

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

LaunchPadTileService Service to manage launch pad tiles in keyhub

func (*LaunchPadTileService) Create added in v1.3.1 

func (s *LaunchPadTileService) Create(tile *model.LaunchPadTile) (result *model.LaunchPadTile, err error)

Create a new launch pad tile in Keyhub

func (*LaunchPadTileService) DeleteById added in v1.3.1 

func (s *LaunchPadTileService) DeleteById(id int64) (err error)

GetById Retrieve a launch pad tile by keyhub id

func (*LaunchPadTileService) GetById added in v1.3.1 

func (s *LaunchPadTileService) GetById(id int64) (result *model.LaunchPadTile, err error)

GetById Retrieve a launch pad tile by keyhub id

func (*LaunchPadTileService) List added in v1.3.1 

func (s *LaunchPadTileService) List(queryParams *model.LaunchPadTileQueryParams) (tiles []model.LaunchPadTile, err error)

List all available launch pad tiles.

type ServiceAccountService added in v1.3.1 

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

func NewServiceAccountService added in v1.3.1 

func NewServiceAccountService(sling *sling.Sling) *ServiceAccountService

NewServiceAccountService Create new ServiceAccountService

func (*ServiceAccountService) Create added in v1.3.1 

func (s *ServiceAccountService) Create(serviceaccount *model.ServiceAccount) (result *model.ServiceAccount, err error)

Create Create a serviceaccount

func (*ServiceAccountService) Delete added in v1.3.1 

func (s *ServiceAccountService) Delete(serviceAccount *model.ServiceAccount) (err error)

Delete Delete a service account by object

func (*ServiceAccountService) DeleteByID added in v1.3.1 

func (s *ServiceAccountService) DeleteByID(id int64) (err error)

DeleteByID Delete a service account by ID

func (*ServiceAccountService) DeleteByUUID added in v1.3.1 

func (s *ServiceAccountService) DeleteByUUID(uuid uuid.UUID) (err error)

DeleteByUUID Delete a service account by uuid for a certain group

func (*ServiceAccountService) GetById added in v1.3.1 

func (s *ServiceAccountService) GetById(id int64) (result *model.ServiceAccount, err error)

GetById Get Service account by ID

func (*ServiceAccountService) GetByUUID added in v1.3.1 

func (s *ServiceAccountService) GetByUUID(uuid uuid.UUID) (result *model.ServiceAccount, err error)

GetByUUID Get Service account by UUID

func (*ServiceAccountService) List added in v1.3.1 

func (s *ServiceAccountService) List(query *model.ServiceAccountQueryParams, additional *model.ServiceAccountAdditionalQueryParams) (list []model.ServiceAccount, err error)

List all Service Accounts

func (*ServiceAccountService) Update added in v1.3.1 

func (s *ServiceAccountService) Update(serviceAccount *model.ServiceAccount) (result *model.ServiceAccount, err error)

Update Update service account

type SystemService added in v1.2.0 

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

func (*SystemService) CreateGroupOnSystem added in v1.2.0 

func (s *SystemService) CreateGroupOnSystem(groupOnSystem *model.GroupOnSystem) (result *model.GroupOnSystem, err error)

func (*SystemService) DeleteGroupOnSystem added in v1.2.0 

func (s *SystemService) DeleteGroupOnSystem(groupOnSystem *model.GroupOnSystem) (err error)

func (*SystemService) FindGroupOnSystem added in v1.2.0 

func (s *SystemService) FindGroupOnSystem(system *model.ProvisionedSystem, query *model.GroupOnSystemQueryParams) (results *model.GroupOnSystemList, err error)

func (*SystemService) GetById added in v1.2.0 

func (s *SystemService) GetById(id int64) (system *model.ProvisionedSystem, err error)

func (*SystemService) GetByUUID added in v1.2.0 

func (s *SystemService) GetByUUID(uuid uuid.UUID) (system *model.ProvisionedSystem, err error)

func (s *SystemService) Create(system *model.ProvisionedSystem) (result *model.ProvisionedSystem, err error) { 

	return
}

func (s *SystemService) List() (systems []model.ProvisionedSystem, err error) {
	return
}

func (*SystemService) GetGroupOnSystem added in v1.2.0 

func (s *SystemService) GetGroupOnSystem(system *model.ProvisionedSystem, groupId int64, additional *model.GroupOnSystemAdditionalQueryParams) (result *model.GroupOnSystem, err error)

type Transport 

type Transport struct {
	Base http.RoundTripper
}

func (*Transport) RoundTrip 

func (t *Transport) RoundTrip(req *http.Request) (*http.Response, error)

RoundTrip Based on oauth2.Transport.RoundTrip()

type VaultService 

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

func (*VaultService) Create added in v1.0.0 

func (s *VaultService) Create(group *model.Group, vaultRecord *model.VaultRecord) (result *model.VaultRecord, err error)

func (*VaultService) DeleteByID added in v1.0.0 

func (s *VaultService) DeleteByID(group *model.Group, id int64) (err error)

DeleteByID Delete a vault record by ID for a certain group, including audit and secrets

func (*VaultService) DeleteByUUID added in v1.0.0 

func (s *VaultService) DeleteByUUID(group *model.Group, uuid uuid.UUID) (err error)

DeleteByUUID Delete a vault record by uuid for a certain group, including audit and secrets

func (*VaultService) FindByIDForClient added in v1.1.0 

func (s *VaultService) FindByIDForClient(id int64, additional *model.VaultRecordAdditionalQueryParams) (result *model.VaultRecord, err error)

func (*VaultService) FindByUUIDForClient added in v1.1.0 

func (s *VaultService) FindByUUIDForClient(uuid uuid.UUID, additional *model.VaultRecordAdditionalQueryParams) (result *model.VaultRecord, err error)

func (*VaultService) GetByID added in v1.0.0 

func (s *VaultService) GetByID(group *model.Group, id int64, additional *model.VaultRecordAdditionalQueryParams) (result *model.VaultRecord, err error)

GetByID Retrieve a vault record by ID for a certain group, including audit and secrets

func (*VaultService) GetByUUID added in v1.0.0 

func (s *VaultService) GetByUUID(group *model.Group, uuid uuid.UUID, additional *model.VaultRecordAdditionalQueryParams) (result *model.VaultRecord, err error)

GetByUUID Retrieve a vault record by uuid for a certain group, including audit and secrets

func (*VaultService) GetRecords 

func (s *VaultService) GetRecords(g *model.Group) (result []model.VaultRecord, err error)

GetRecords Retrieve all vault records for a group including audit (secrets are not included)

func (*VaultService) List added in v1.0.0 

func (s *VaultService) List(group *model.Group, query *model.VaultRecordQueryParams, additional *model.VaultRecordAdditionalQueryParams) (records []model.VaultRecord, err error)

List Retrieve all vault records for a group (secrets are not included, default audit = true)

func (*VaultService) Update added in v1.0.0 

func (s *VaultService) Update(group *model.Group, vaultRecord *model.VaultRecord) (result *model.VaultRecord, err error)

Update Retrieve a vault record by uuid for a certain group, including audit and secrets

type VersionService 

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

func (*VersionService) CheckAndUpdateVersionedSling added in v1.3.2 

func (s *VersionService) CheckAndUpdateVersionedSling(version int, base *sling.Sling) (isSupported bool, err error)

func (*VersionService) Get 

func (s *VersionService) Get() (v *model.VersionInfo, err error)

Source Files

View all Source files

Directories

Path Synopsis
example module

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.