sdkgo

package module
v0.33.0 Latest Latest
Warning

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

 Go to latest Published: Apr 24, 2024 License: Apache-2.0 Imports: 40 Imported by: 2

README

Topicus KeyHub SDK for Go

PkgGoDev

Note: The version number of the SDK must match the version of your Topicus KeyHub installation. An older version of the SDK might work on a newer version of Topicus KeyHub via the provided backwards compatibility layer, but a newer of the SDK will not work on an older version of Topicus KeyHub.

Note: The GO SDK is current considered in alpha status. It's API might change in future version, it is largely untested and at the moment only supports the client credentials grant.

1. Installation

go get github.com/topicuskeyhub/sdk-go

2. Getting started

2.1 Create a client application in Topicus KeyHub

Register a OAuth 2.0 client application in Topicus KeyHub as described in section 16.1 of the manual. Section 16.5 describes the permissions you can assign to this application.

2.2 Create a KeyHubClient object and make an API call
package main

import (
	"context"
	"log"
	"net/http"

	keyhub "github.com/topicuskeyhub/sdk-go"
)

func main() {
	issuer := "<the issuer of your Topicus KeyHub installation>"
	clientid := "<the client id of your application registration>"
	clientsecret := "<the client sercret of your application registration>"

	adapter, err := keyhub.NewKeyHubRequestAdapter(http.DefaultClient, issuer, clientid, clientsecret)
	if err != nil {
		log.Fatalf("Cannot create request adapter: %v\n", err)
	}

	client := keyhub.NewKeyHubClient(adapter)
	me, err := client.Client().Me().Get(context.Background(), nil)
	if err != nil {
		log.Fatalf("Error getting /client/me: %v\n", err)
	}
	log.Printf("me: %s", *me.GetName())
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ContextClient added in v0.30.0 

func ContextClient(ctx context.Context) *nethttp.Client

func DeviceAuth added in v0.30.0 

func DeviceAuth(ctx context.Context, c *oauth2.Config, opts ...oauth2.AuthCodeOption) (*oauth2.DeviceAuthResponse, error)

copied from https://github.com/golang/oauth2/blob/master/deviceauth.go until https://github.com/golang/oauth2/issues/685 is fixed DeviceAuth returns a device auth struct which contains a device code and authorization information provided for users to enter on another device.

func NewKeyHubRequestAdapter 

func NewKeyHubRequestAdapter(client *nethttp.Client, issuer string, clientID string, clientSecret string) (*http.NetHttpRequestAdapter, error)

func NewKeyHubRequestAdapterForDeviceCode added in v0.30.0 

func NewKeyHubRequestAdapterForDeviceCode(client *nethttp.Client, issuer string, clientID string, clientSecret string, scopes []string) (*http.NetHttpRequestAdapter, error)

func OpenAPISpec added in v0.28.1 

func OpenAPISpec() []byte

Types

type KeyHubAccessTokenProvider 

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

func NewKeyHubAccessTokenProvider 

func NewKeyHubAccessTokenProvider(tokenSource *oauth2.TokenSource) *KeyHubAccessTokenProvider

func (*KeyHubAccessTokenProvider) GetAllowedHostsValidator 

func (p *KeyHubAccessTokenProvider) GetAllowedHostsValidator() *auth.AllowedHostsValidator

func (*KeyHubAccessTokenProvider) GetAuthorizationToken 

func (p *KeyHubAccessTokenProvider) GetAuthorizationToken(ctx context.Context, url *url.URL, additionalAuthenticationContext map[string]interface{}) (string, error)

func (*KeyHubAccessTokenProvider) Intercept 

func (p *KeyHubAccessTokenProvider) Intercept(pipeline http.Pipeline, middlewareIndex int, req *nethttp.Request) (*nethttp.Response, error)

type KeyHubClient 

type KeyHubClient struct {
	i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}

KeyHubClient the main entry point of the SDK, exposes the configuration and the fluent API.

func NewKeyHubClient 

func NewKeyHubClient(requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *KeyHubClient

NewKeyHubClient instantiates a new KeyHubClient and sets the default values.

func (*KeyHubClient) Account 

func (m *KeyHubClient) Account() *ib269aad83a59eeaa00948e8e0cf61b0f8955fcb99e4910b745aa70768d6d63c4.AccountRequestBuilder

Account the account property returns a *AccountRequestBuilder when successful

func (*KeyHubClient) Audit 

func (m *KeyHubClient) Audit() *i9a416ff0973cadc86a9386e3f28ad7c475076105c80d51f978001646d6a93eb8.AuditRequestBuilder

Audit the audit property returns a *AuditRequestBuilder when successful

func (*KeyHubClient) Certificate 

func (m *KeyHubClient) Certificate() *ia4ccd640f04375f8459d703d9bd3e36f5d6a57b48d83c18fcc686ac92a251806.CertificateRequestBuilder

Certificate the certificate property returns a *CertificateRequestBuilder when successful

func (*KeyHubClient) Client 

func (m *KeyHubClient) Client() *ifdfb91cbbf9b2d09fc5fb9b2405c3a72348d071234970eca4305212177f72cf2.ClientRequestBuilder

Client the client property returns a *ClientRequestBuilder when successful

func (*KeyHubClient) Deletedvaultholder 

func (m *KeyHubClient) Deletedvaultholder() *i9acdc2253f5a58228075fc1e46bdd8aca4f69569179560e0bf2e87d0811bfc18.DeletedvaultholderRequestBuilder

Deletedvaultholder the deletedvaultholder property returns a *DeletedvaultholderRequestBuilder when successful

func (*KeyHubClient) Directory 

func (m *KeyHubClient) Directory() *ib7bf253b601139c5fca70bba4f4843e6731e3522bee75715df4b77d2107eff28.DirectoryRequestBuilder

Directory the directory property returns a *DirectoryRequestBuilder when successful

func (*KeyHubClient) Export added in v0.29.0 

func (m *KeyHubClient) Export() *ie19695769860c2ce81c94e08d7b1cdbbd24da28301e01a4408a5565b07ee913d.ExportRequestBuilder

Export the export property returns a *ExportRequestBuilder when successful

func (*KeyHubClient) Group 

func (m *KeyHubClient) Group() *i6f1edc8cb6d249770cb1634d5c07b8945f2349df7d873c8e22898a5bfd8123aa.GroupRequestBuilder

Group the group property returns a *GroupRequestBuilder when successful

func (*KeyHubClient) Groupclassification 

func (m *KeyHubClient) Groupclassification() *i3786de14b5891e0b6237ed5a04286048bb7ccab8227911414f7bb8f1e165a7c0.GroupclassificationRequestBuilder

Groupclassification the groupclassification property returns a *GroupclassificationRequestBuilder when successful

func (*KeyHubClient) Groupclient 

func (m *KeyHubClient) Groupclient() *i4f6f8a97ade4bcd9f00e48fb22660ba2cb3b474e860f677cfc37ab0f9b6d8370.GroupclientRequestBuilder

Groupclient the groupclient property returns a *GroupclientRequestBuilder when successful

func (*KeyHubClient) Groupfolder 

func (m *KeyHubClient) Groupfolder() *i43af1840a4616958e60c4cbee17a55c9c7345f03d798c4b93f71ba6ea8a8fed7.GroupfolderRequestBuilder

Groupfolder the groupfolder property returns a *GroupfolderRequestBuilder when successful

func (*KeyHubClient) Info 

func (m *KeyHubClient) Info() *ia9c84b329cdbc7e9961b248161459b4dfb0d53b98e1b471cd7c10b6d027a90d3.InfoRequestBuilder

Info the info property returns a *InfoRequestBuilder when successful

func (*KeyHubClient) Launchpadtile 

func (m *KeyHubClient) Launchpadtile() *i385775f507ab02e04cf3e40e8696ee406fb1371e877539b6dfbde0c8e4b123b2.LaunchpadtileRequestBuilder

Launchpadtile the launchpadtile property returns a *LaunchpadtileRequestBuilder when successful

func (*KeyHubClient) Numberseq 

func (m *KeyHubClient) Numberseq() *i98ee0f07cd6158c2879ae08ef6a731b5a05b3610b774bf729ac7c7bf7d1efa2c.NumberseqRequestBuilder

Numberseq the numberseq property returns a *NumberseqRequestBuilder when successful

func (*KeyHubClient) Organizationalunit 

func (m *KeyHubClient) Organizationalunit() *ifb310ad74101a00ed1acdc17b384ce2e8964f5a38f9d9302b22aaaa28ff4d3e4.OrganizationalunitRequestBuilder

Organizationalunit the organizationalunit property returns a *OrganizationalunitRequestBuilder when successful

func (*KeyHubClient) Profile added in v0.33.0 

func (m *KeyHubClient) Profile() *i3e244f19958aced6afc8c02a477435c3f0af5f60044658105a73a312fcf20b03.ProfileRequestBuilder

Profile the profile property returns a *ProfileRequestBuilder when successful

func (*KeyHubClient) Provisioninggroup 

func (m *KeyHubClient) Provisioninggroup() *i29b864faf50a3a1afdf661366bb4234f149662638d0e3841e35acccd9352cf20.ProvisioninggroupRequestBuilder

Provisioninggroup the provisioninggroup property returns a *ProvisioninggroupRequestBuilder when successful

func (*KeyHubClient) Request 

func (m *KeyHubClient) Request() *i4e9df38273eb83f44b000e660fb1ceeb2fdcb7939eb1e594bf0e1c6dd130c8e2.RequestRequestBuilder

Request the request property returns a *RequestRequestBuilder when successful

func (*KeyHubClient) Serviceaccount 

func (m *KeyHubClient) Serviceaccount() *i25381d874a7e3097702763676eb8a598478a75d07191e3563cf4ef48e5ac1fc6.ServiceaccountRequestBuilder

Serviceaccount the serviceaccount property returns a *ServiceaccountRequestBuilder when successful

func (*KeyHubClient) System 

func (m *KeyHubClient) System() *ibdde25a8196c6c3406e5b0b02de36d833849b28ee37dca06694dc2ec8a725bdc.SystemRequestBuilder

System the system property returns a *SystemRequestBuilder when successful

func (*KeyHubClient) Vaultrecord 

func (m *KeyHubClient) Vaultrecord() *i9c60bc0bc864eda4e8fcd5447d4e572d9b6ba65365f60dea8e1097309b0531da.VaultrecordRequestBuilder

Vaultrecord the vaultrecord property returns a *VaultrecordRequestBuilder when successful

func (*KeyHubClient) Webhook 

func (m *KeyHubClient) Webhook() *i7f1810e47506a1087d42711bae10d2eacb3eb432b8e9e68ef97ff738e3bb6945.WebhookRequestBuilder

Webhook the webhook property returns a *WebhookRequestBuilder when successful

Source Files

View all Source files

Directories

Path Synopsis
item
item/group
item/group/item
item/organizationalunit
item/organizationalunit/item
item/vault/record
item/vault/record/item
item
item
item
item/permission
item/permission/item
item/vault/record
item/vault/record/item
item
item/vault/record
item/vault/record/item
item
item/internalaccount
item/internalaccount/item
item
item/account
item/account/item
item/audit
item/audit/item
item/vault/record
item/vault/record/item
item
item
item
item
item
item
item/account
item/account/item
item
item
item
item
item/group
item/group/item
item
item/account
item/account/item
item/group
item/group/item
item/synclog
item/synclog/item
item
item
item/delivery
item/delivery/item

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.