Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  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

v1

v1.1.0

Feb 2, 2026

Changes in this version

+ var ErrClusterNotFound = errors.New("cluster not found")

+ var ErrTeamNotFound = errors.New("team not found")

+ var ErrUserNotFound = errors.New("user not found")

+ func GetClusterMemberRoleValues() []string

+ func GetMemberRoleValues() []string

+ type AddClusterMemberRequest struct

+ Roles []ClusterMemberRole

+ Subject AddClusterMemberSubject

+ type AddClusterMemberSubject struct

+ ID string

+ Type string

+ type AddClusterMembersPayload struct

+ Values []AddClusterMemberRequest

+ type AddMemberSubject struct

+ ID string

+ Type string

+ type AddTeamMemberRequest struct

+ Roles []MemberRole

+ Subject AddMemberSubject

+ type Client interface

+ type Cluster struct

+ ConsoleURL string

+ EPG string

+ ID string

+ IngressIP string

+ Name string

+ NodePools NodePools

+ Roles []string

+ Status ClusterStatus

+ Version string

+ type ClusterClient interface

+ AddClusterMember func(ctx context.Context, clusterID string, request []AddClusterMemberRequest) error

+ CreateCluster func(ctx context.Context, request NewClusterRequest) (*Cluster, error)

+ DeleteCluster func(ctx context.Context, name string) error

+ GetCluster func(ctx context.Context, name string) (*Cluster, error)

+ GetClusterMembers func(ctx context.Context, clusterID string) ([]ClusterMember, error)

+ GetClusterStatus func(ctx context.Context, clusterID string) (*Cluster, error)

+ ListClusters func(ctx context.Context) (ClusterList, error)

+ RemoveClusterMember func(ctx context.Context, clusterID string, memberID string) error

+ type ClusterList []Cluster

+ type ClusterMember struct

+ Roles []ClusterMemberRole

+ Subject ClusterMemberSubject

+ type ClusterMemberRole string

+ const ClusterMemberRoleAdmin

+ const ClusterMemberRoleReader

+ func (r ClusterMemberRole) IsValid() bool

+ func (r ClusterMemberRole) String() string

+ type ClusterMemberSubject struct

+ Details string

+ ID uuid.UUID

+ Name string

+ Type string

+ type ClusterStatus struct

+ Deployment StatusDeployment

+ Ready StatusReady

+ type ComputeResources struct

+ Cores int

+ Memory string

+ type DeleteTeamRequest struct

+ TeamID string

+ type IntegrationClient interface

+ ListIntegrationInstances func(ctx context.Context) ([]IntegrationInstance, error)

+ type IntegrationInstance struct

+ CreatedAt time.Time

+ ID string

+ Name string

+ Type string

+ type Me struct

+ ID string

+ Name string

+ OrganizationName string

+ OrganizationRoles []string

+ type MeClient interface

+ GetMe func(ctx context.Context) (Me, error)

+ type MemberClient interface

+ AddTeamMember func(ctx context.Context, teamID string, request []AddTeamMemberRequest) error

+ RemoveTeamMember func(ctx context.Context, teamID string, memberID string) error

+ type MemberRole string

+ const MemberRoleMember

+ const MemberRoleOwner

+ func (mr MemberRole) IsValid() bool

+ func (mr MemberRole) String() string

+ type NewClusterRequest struct

+ Environment string

+ Name string

+ NodePools NodePools

+ PullSecretRef *string

+ SSOProvisioner string

+ Version string

+ type NewTeamRequest struct

+ Description string

+ Name string

+ type NodePool struct

+ AutoscalingEnabled bool

+ Compute *ComputeResources

+ ID string

+ MaxCount *int

+ MinCount *int

+ Name string

+ Preset string

+ Replicas *int

+ type NodePools []NodePool

+ type RequestError struct

+ Message string

+ func (e *RequestError) Error() string

+ type RestClient struct

+ func New(options ...RestClientOption) *RestClient

+ func (c *RestClient) AddClusterMember(ctx context.Context, clusterID string, request []AddClusterMemberRequest) error

+ func (c *RestClient) AddTeamMember(ctx context.Context, teamID string, request []AddTeamMemberRequest) error

+ func (c *RestClient) CreateCluster(ctx context.Context, request NewClusterRequest) (*Cluster, error)

+ func (c *RestClient) CreateTeam(ctx context.Context, request NewTeamRequest) (*Team, error)

+ func (c *RestClient) DeleteCluster(ctx context.Context, id string) error

+ func (c *RestClient) DeleteTeam(ctx context.Context, request DeleteTeamRequest) error

+ func (c *RestClient) GetCluster(ctx context.Context, name string) (*Cluster, error)

+ func (c *RestClient) GetClusterMembers(ctx context.Context, clusterID string) ([]ClusterMember, error)

+ func (c *RestClient) GetClusterStatus(ctx context.Context, clusterID string) (*Cluster, error)

+ func (c *RestClient) GetMe(ctx context.Context) (Me, error)

+ func (c *RestClient) GetTeam(ctx context.Context, name string) (*Team, error)

+ func (c *RestClient) GetTeamMembers(ctx context.Context, teamID string) ([]TeamMember, error)

+ func (c *RestClient) GetUser(ctx context.Context, upn string) (*User, error)

+ func (c *RestClient) ListClusters(ctx context.Context) (ClusterList, error)

+ func (c *RestClient) ListIntegrationInstances(ctx context.Context) ([]IntegrationInstance, error)

+ func (c *RestClient) ListTeams(ctx context.Context) ([]Team, error)

+ func (c *RestClient) ListUsers(ctx context.Context) ([]User, error)

+ func (c *RestClient) RemoveClusterMember(ctx context.Context, clusterID string, memberID string) error

+ func (c *RestClient) RemoveTeamMember(ctx context.Context, teamID string, memberID string) error

+ type RestClientOption func(*RestClient)

+ func WithAuthenticator(authenticator *authenticator.Authenticator) RestClientOption

+ func WithHTTPClient(httpClient *http.Client) RestClientOption

+ type StatusDeployment struct

+ Active bool

+ Failed bool

+ type StatusReady struct

+ Message string

+ Reason string

+ Status bool

+ type Subject struct

+ Details string

+ ID uuid.UUID

+ Name string

+ Type string

+ type Team struct

+ Description string

+ ID string

+ Name string

+ Role []string

+ type TeamList []Team

+ type TeamMember struct

+ Roles []MemberRole

+ Subject Subject

+ type TeamsClient interface

+ CreateTeam func(ctx context.Context, request NewTeamRequest) (*Team, error)

+ DeleteTeam func(ctx context.Context, request DeleteTeamRequest) error

+ GetTeam func(ctx context.Context, name string) (*Team, error)

+ GetTeamMembers func(ctx context.Context, teamID string) ([]TeamMember, error)

+ ListTeams func(ctx context.Context) ([]Team, error)

+ type User struct

+ ID string

+ Name string

+ Roles []string

+ UPN string

+ type UserClient interface

+ GetUser func(ctx context.Context, upn string) (*User, error)

+ ListUsers func(ctx context.Context) ([]User, error)

+ type UserList []User

v1.0.0

Jan 30, 2026

v0

v0.9.1

Jan 29, 2026

v0.9.0

Jan 20, 2026

v0.8.1

Jan 13, 2026

v0.8.0

Dec 19, 2025

v0.7.0

Dec 16, 2025

v0.6.0

Nov 7, 2025

v0.5.0

Nov 6, 2025

v0.4.1

Nov 4, 2025

v0.4.0

Nov 4, 2025

v0.3.3

Nov 4, 2024

v0.3.3-6

Nov 12, 2024

v0.3.3-5

Nov 5, 2024

v0.3.3-4

Nov 5, 2024

v0.3.3-3

Nov 5, 2024

v0.3.3-2

Nov 5, 2024

v0.3.3-1

Nov 4, 2024