Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

client

package

Go to main page

Versions in this module

v0

v0.2.5

Dec 20, 2023

v0.2.4

Dec 7, 2023

v0.2.3

Oct 24, 2023

v0.2.2

Aug 23, 2023

v0.2.1

Aug 23, 2023

Changes in this version

+ func GeneratePass() string

+ type AccountFilter string

+ const AccountFilterActiveUsers

+ const AccountFilterAdmins

+ const AccountFilterInactiveUsers

+ const AccountFilterNonAdmins

+ const AccountFilterOrgs

+ const AccountFilterUsers

+ const URLTargetForAccounts

+ func (accF AccountFilter) APIFormOfFilter() string

type Client

+ func (c *Client) ApiCreateAccount(ctx context.Context, acc CreateAccount) (ResponseAccount, error)

+ func (c *Client) ApiDeleteAccount(ctx context.Context, id string) error

+ func (c *Client) ApiReadAccount(ctx context.Context, id string) (ResponseAccount, error)

+ func (c *Client) ApiReadAccounts(ctx context.Context, accFilter AccountFilter) ([]ResponseAccount, error)

+ func (c *Client) ApiUpdateAccount(ctx context.Context, id string, acc UpdateAccount) (ResponseAccount, error)

+ type CreateAccount struct

+ FullName string

+ ID string

+ IsActive bool

+ IsAdmin bool

+ IsOrg bool

+ Name string

+ Password string

+ SearchLDAP bool

+ type ResponseAccount struct

+ FullName string

+ ID string

+ IsActive bool

+ IsAdmin bool

+ IsImported bool

+ IsOrg bool

+ MembersCount int

+ Name string

+ OnDemand bool

+ OtpEnabled bool

+ TeamsCount int

+ type ResponseAccounts struct

+ Accounts []ResponseAccount

+ NextPageStart string

+ OrgsCount int

+ ResourceCount int

+ UsersCount int

+ type UpdateAccount struct

+ FullName string

+ IsActive bool

+ IsAdmin bool

v0.2.0

Aug 15, 2023

Changes in this version

+ const ClientBundleMetaEndpointDocker

+ const ClientBundleMetaEndpointKubernetes

+ const EndpointDefaultScheme

+ const HeaderKeyAuthorization

+ const URLTargetForAuth

+ const URLTargetForClientBundle

+ const URLTargetForClientBundleQueryLabel

+ const URLTargetForPing

+ const URLTargetPatternForPublicKey

+ const URLTargetPatternForPublicKeys

+ var ErrCouldNotCreateClient = errors.New("could not create a client")

+ var ErrEmptyEndpoint = errors.New("no endpoint provided in MKE client")

+ var ErrEmptyResError = errors.New("request returned empty ResponseError struct in MKE client")

+ var ErrEmptyStruct = errors.New("empty struct passed in MKE client")

+ var ErrEmptyUsernamePass = errors.New("no username or password provided in MKE client")

+ var ErrFailedToFindClientBundleMKEPublicKey = errors.New("no MKE Public key was found that matches the client bundle")

+ var ErrFailedToRetrieveClientBundle = errors.New("failed to retrieve the client bundle from MKE")

+ var ErrInvalidFilter = errors.New("passing invalid account retrieval filter in MKE client")

+ var ErrMarshaling = errors.New("error occurred while marshalling struct in MKE client")

+ var ErrRequestCreation = errors.New("error creating request in MKE client")

+ var ErrResponseError = errors.New("request returned ResponseError in MKE client")

+ var ErrServerError = errors.New("server error occurred")

+ var ErrUnauthorizedReq = errors.New("unauthorized request in MKE client")

+ var ErrUnknownTarget = errors.New("unknown API target")

+ var ErrUnmarshaling = errors.New("error occurred while unmarshalling struct in MKE client")

+ func BearerTokenHeaderValue(token string) string

+ func ClientBundleDecodeBase64Value(val io.Reader) (string, error)

+ func ClientBundleRetrieveValue(val io.Reader) (string, error)

+ func NewLoginResponse(token string) loginResponse

+ type AccountPublicKey struct

+ AccountID string

+ Certificates []Certificate

+ ID string

+ Label string

+ PublicKey string

+ type Auth struct

+ Code string

+ Password string

+ Token string

+ UseTLS bool

+ Username string

+ func NewAuthUP(username, password string) Auth

+ type Certificate struct

+ Cert string

+ Label string

+ type Client struct

+ HTTPClient *http.Client

+ func NewClient(apiURL *url.URL, auth *Auth, HTTPClient *http.Client) (Client, error)

+ func NewClientSimple(endpoint, username, password string) (Client, error)

+ func NewUnsafeSSLClient(endpoint, username, password string) (Client, error)

+ func (c *Client) ApiAuthorizedGeneric(ctx context.Context, req *http.Request) (*Response, error)

+ func (c *Client) ApiClientBundleCreate(ctx context.Context, label string) (ClientBundle, error)

+ func (c *Client) ApiClientBundleDelete(ctx context.Context, cb ClientBundle) error

+ func (c *Client) ApiClientBundleGetPublicKey(ctx context.Context, cb ClientBundle) (AccountPublicKey, error)

+ func (c *Client) ApiGeneric(ctx context.Context, req *http.Request) (*Response, error)

+ func (c *Client) ApiLogin(ctx context.Context) error

+ func (c *Client) ApiPing(ctx context.Context) error

+ func (c *Client) ApiPublicKeyDelete(ctx context.Context, account, keyid string) error

+ func (c *Client) ApiPublicKeyList(ctx context.Context, account string) ([]AccountPublicKey, error)

+ func (c *Client) ApiPublicKeyRetrieve(ctx context.Context, account, keyid string) (AccountPublicKey, error)

+ func (c *Client) RequestFromTargetAndBytesBody(ctx context.Context, method, target string, body []byte) (*http.Request, error)

+ func (c *Client) RequestFromTargetAndJSONBody(ctx context.Context, method, target string, body interface{}) (*http.Request, error)

+ func (c *Client) Username() string

+ type ClientBundle struct

+ CACert string

+ Cert string

+ ID string

+ Kube *ClientBundleKube

+ Meta ClientBundleMeta

+ PrivateKey string

+ PublicKey string

+ func (cb ClientBundle) ToJSON() []byte

+ type ClientBundleKube struct

+ CACertificate string

+ ClientCertificate string

+ ClientKey string

+ Config string

+ Host string

+ Insecure string

+ func NewClientBundleKubeFromKubeYml(val io.Reader) (ClientBundleKube, error)

+ type ClientBundleMeta struct

+ Description string

+ DockerHost string

+ DockerSkipVerifyTLS bool

+ KubernetesHost string

+ KubernetesSkipVerifyTLS bool

+ Name string

+ StackOrchestrator string

+ func NewClientBundleMetaFromReader(val io.Reader) (ClientBundleMeta, error)

+ type GetKeysResponse struct

+ AccountPubKeys []AccountPublicKey

+ NextPageStart string

+ type Response struct

+ func (r *Response) BodyBytes() ([]byte, error)

+ func (r *Response) JSONMarshallBody(target interface{}) error