state

package
v1.0.0 Latest Latest
Warning

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

 Go to latest Published: May 20, 2026 License: Apache-2.0 Imports: 20 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	ErrMsgPortalAPINotConfigured              = "Portal API client not configured"
	ErrMsgAPIAPINotConfigured                 = "API client not configured"
	ErrMsgAuthStrategyAPINotConfigured        = "app auth API client not configured"
	ErrMsgAPIVersionAPINotConfigured          = "API version client not configured"
	ErrMsgAPIPublicationAPINotConfigured      = "API publication client not configured"
	ErrMsgAPIImplementationAPINotConfigured   = "API implementation client not configured"
	ErrMsgAPIDocumentAPINotConfigured         = "API document client not configured"
	ErrMsgPortalPageAPINotConfigured          = "portal page API not configured"
	ErrMsgPortalSnippetAPINotConfigured       = "portal snippet API not configured"
	ErrMsgPortalCustomizationAPINotConfigured = "portal customization API not configured"
	ErrMsgPortalCustomDomainAPINotConfigured  = "portal custom domain API not configured"
	ErrMsgPortalEmailsAPINotConfigured        = "portal emails API not configured"
)

Standard error messages for common scenarios

Variables

This section is empty.

Functions

func IsAPIClientError 

func IsAPIClientError(err error) bool

IsAPIClientError checks if an error is an API client not configured error

func IsResponseValidationError 

func IsResponseValidationError(err error) bool

IsResponseValidationError checks if an error is a response validation error

func NewAPIClientNotConfiguredError 

func NewAPIClientNotConfiguredError(clientType string) error

NewAPIClientNotConfiguredError creates a standard "client not configured" error

func NewResponseValidationError 

func NewResponseValidationError(operation, expectedType string) error

NewResponseValidationError creates a standard response validation error

func PaginateAll 

func PaginateAll[T any](ctx context.Context, lister PaginatedLister[T]) ([]T, error)

PaginateAll fetches all pages from a paginated API endpoint

func PaginateAllFiltered 

func PaginateAllFiltered[T any](
	ctx context.Context, lister FilteredPaginatedLister[T], filter func(T) bool,
) ([]T, error)

PaginateAllFiltered fetches all pages from a paginated API endpoint with filtering

func ValidateAPIClient 

func ValidateAPIClient(client any, clientType string) error

ValidateAPIClient checks if an API client interface is configured (not nil)

func ValidateResponse 

func ValidateResponse[T any](response *T, operation string) error

ValidateResponse checks if a response pointer contains non-nil data

func WrapAPIError 

func WrapAPIError(err error, operation string, opts *ErrorWrapperOptions) error

WrapAPIError wraps an API error with consistent formatting and optional enhancement

Types

type API 

type API struct {
	kkComps.APIResponseSchema
	NormalizedLabels map[string]string // Non-pointer labels
}

API represents a normalized API for internal use

type APIClientError 

type APIClientError struct {
	ClientType string
}

APIClientError represents an error when an API client is not configured

func (*APIClientError) Error 

func (e *APIClientError) Error() string

type APIDocument 

type APIDocument struct {
	ID               string
	Content          string
	Title            string
	Slug             string
	Status           string
	ParentDocumentID string
}

APIDocument represents an API document for internal use

type APIImplementation 

type APIImplementation struct {
	ID                string
	ImplementationURL string
	Service           *struct {
		ID             string
		ControlPlaneID string
	}
}

APIImplementation represents an API implementation for internal use

type APIPublication 

type APIPublication struct {
	ID                       string
	PortalID                 string
	AuthStrategyIDs          []string
	AutoApproveRegistrations bool
	Visibility               string
}

APIPublication represents an API publication for internal use

type APIVersion 

type APIVersion struct {
	ID            string
	Version       string
	PublishStatus string
	Deprecated    bool
	SunsetDate    string
	Spec          string // API version spec content for content comparison
}

APIVersion represents an API version for internal use

type ApplicationAuthStrategy 

type ApplicationAuthStrategy struct {
	ID               string
	Name             string
	DisplayName      string
	StrategyType     string
	DCRProviderID    string
	DCRProviderName  string
	Configs          map[string]any
	NormalizedLabels map[string]string // Non-pointer labels
}

ApplicationAuthStrategy represents a normalized auth strategy for internal use

type AuditLogWebhookDestination added in v0.10.0 

type AuditLogWebhookDestination struct {
	ID                  string
	Name                string
	Endpoint            string
	LogFormat           string
	SkipSSLVerification *bool
	CreatedAt           string
	UpdatedAt           string
}

AuditLogWebhookDestination represents a Konnect audit-log webhook destination.

type Cache 

type Cache struct {
	// Top-level resources
	Portals                   map[string]*CachedPortal            // portalID -> portal with children
	APIs                      map[string]*CachedAPI               // apiID -> api with children
	ApplicationAuthStrategies map[string]*ApplicationAuthStrategy // strategyID -> strategy
}

Cache represents cached Konnect state with hierarchical structure

func NewCache 

func NewCache() *Cache

NewCache creates an initialized cache

type CachedAPI 

type CachedAPI struct {
	API

	// Child resources
	Versions        map[string]*APIVersion        // versionID -> version
	Publications    map[string]*APIPublication    // portalID -> publication (one per portal)
	Implementations map[string]*APIImplementation // implementationID -> implementation
	Documents       map[string]*CachedAPIDocument // documentID -> document (with nested children)
}

CachedAPI represents an API with all its child resources

type CachedAPIDocument 

type CachedAPIDocument struct {
	APIDocument

	// Child documents indexed by ID
	Children map[string]*CachedAPIDocument // documentID -> child document
}

CachedAPIDocument represents a document with its children

type CachedPortal 

type CachedPortal struct {
	Portal

	// Child resources
	Pages         map[string]*CachedPortalPage // pageID -> page (with nested children)
	Customization *PortalCustomization         // singleton
	CustomDomain  *PortalCustomDomain          // singleton
	Snippets      map[string]*PortalSnippet    // snippetID -> snippet
	Teams         map[string]*PortalTeam       // teamID -> team
	TeamRoles     map[string]*PortalTeamRole   // roleAssignmentID -> role
}

CachedPortal represents a portal with all its child resources

func (*CachedPortal) FindPageBySlugPath 

func (p *CachedPortal) FindPageBySlugPath(slugPath string) *CachedPortalPage

FindPageBySlugPath finds a page by its full slug path

func (*CachedPortal) GetPortalPage 

func (p *CachedPortal) GetPortalPage(pageID string) *CachedPortalPage

GetPortalPage finds a page anywhere in the portal hierarchy

type CachedPortalPage 

type CachedPortalPage struct {
	PortalPage

	// Child pages indexed by ID
	Children map[string]*CachedPortalPage // pageID -> child page
}

CachedPortalPage represents a page with its children

func (*CachedPortalPage) GetDescendant 

func (p *CachedPortalPage) GetDescendant(pageID string) *CachedPortalPage

GetDescendant finds a descendant page by ID

type CatalogService added in v0.3.6 

type CatalogService struct {
	kkComps.CatalogService
	NormalizedLabels map[string]string
}

CatalogService represents a catalog service for internal use.

type Client 

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

Client wraps Konnect SDK for state management

func NewClient 

func NewClient(config ClientConfig) *Client

NewClient creates a new state client with the provided configuration

func (*Client) AddOrganizationSystemAccountToTeam added in v1.0.0 

func (c *Client) AddOrganizationSystemAccountToTeam(ctx context.Context, accountID string, teamID string) error

AddOrganizationSystemAccountToTeam adds a system account to an organization team.

func (*Client) AddOrganizationUserToTeam added in v1.0.0 

func (c *Client) AddOrganizationUserToTeam(ctx context.Context, userID string, teamID string) error

AddOrganizationUserToTeam adds a user to an organization team.

func (*Client) AssignOrganizationSystemAccountRole added in v1.0.0 

func (c *Client) AssignOrganizationSystemAccountRole(
	ctx context.Context,
	accountID string,
	req kkComps.AssignRole,
	namespace string,
) (string, error)

AssignOrganizationSystemAccountRole assigns a role to an organization system account.

func (*Client) AssignOrganizationTeamRole added in v1.0.0 

func (c *Client) AssignOrganizationTeamRole(
	ctx context.Context,
	teamID string,
	req kkComps.AssignRole,
	namespace string,
) (string, error)

AssignOrganizationTeamRole assigns a role to an organization team.

func (*Client) AssignOrganizationUserRole added in v1.0.0 

func (c *Client) AssignOrganizationUserRole(
	ctx context.Context,
	userID string,
	req kkComps.AssignRole,
	namespace string,
) (string, error)

AssignOrganizationUserRole assigns a role to an organization user.

func (*Client) AssignPortalTeamRole added in v0.3.4 

func (c *Client) AssignPortalTeamRole(
	ctx context.Context,
	portalID string,
	teamID string,
	req kkComps.PortalAssignRoleRequest,
	namespace string,
) (string, error)

AssignPortalTeamRole assigns a role to a portal team

func (*Client) CreateAPI 

func (c *Client) CreateAPI(
	ctx context.Context,
	api kkComps.CreateAPIRequest,
	namespace string,
) (*kkComps.APIResponseSchema, error)

CreateAPI creates a new API with management labels

func (*Client) CreateAPIDocument 

func (c *Client) CreateAPIDocument(
	ctx context.Context, apiID string, document kkComps.CreateAPIDocumentRequest,
) (*kkComps.APIDocumentResponse, error)

CreateAPIDocument creates a new API document

func (*Client) CreateAPIImplementation 

func (c *Client) CreateAPIImplementation(
	ctx context.Context, apiID string, implementation kkComps.APIImplementation,
) (*kkComps.APIImplementationResponse, error)

CreateAPIImplementation creates a new API implementation

func (*Client) CreateAPIPublication 

func (c *Client) CreateAPIPublication(
	ctx context.Context, apiID string, portalID string, publication kkComps.APIPublication,
) (*kkComps.APIPublicationResponse, error)

CreateAPIPublication creates a new API publication

func (*Client) CreateAPIVersion 

func (c *Client) CreateAPIVersion(
	ctx context.Context, apiID string, version kkComps.CreateAPIVersionRequest,
) (*kkComps.APIVersionResponse, error)

CreateAPIVersion creates a new API version

func (*Client) CreateApplicationAuthStrategy 

func (c *Client) CreateApplicationAuthStrategy(
	ctx context.Context,
	authStrategy kkComps.CreateAppAuthStrategyRequest,
	_ string,
) (*kkOps.CreateAppAuthStrategyResponse, error)

CreateApplicationAuthStrategy creates a new application auth strategy with management labels

func (*Client) CreateCatalogService added in v0.3.6 

func (c *Client) CreateCatalogService(
	ctx context.Context,
	req kkComps.CreateCatalogService,
	namespace string,
) (*kkComps.CatalogService, error)

CreateCatalogService creates a new catalog service with management labels.

func (*Client) CreateControlPlane added in v0.1.6 

func (c *Client) CreateControlPlane(
	ctx context.Context,
	controlPlane kkComps.CreateControlPlaneRequest,
	namespace string,
) (*kkComps.ControlPlane, error)

CreateControlPlane creates a new control plane with management labels

func (*Client) CreateControlPlaneDataPlaneCertificate added in v0.10.0 

func (c *Client) CreateControlPlaneDataPlaneCertificate(
	ctx context.Context,
	controlPlaneID string,
	req kkComps.DataPlaneClientCertificateRequest,
	namespace string,
) (string, error)

func (*Client) CreateDCRProvider added in v0.8.0 

func (c *Client) CreateDCRProvider(
	ctx context.Context,
	provider kkComps.CreateDcrProviderRequest,
	_ string,
) (*DCRProvider, error)

CreateDCRProvider creates a new DCR provider with management labels.

func (*Client) CreateDashboard added in v1.0.0 

func (c *Client) CreateDashboard(
	ctx context.Context,
	req kkComps.DashboardUpdateRequest,
	namespace string,
) (*kkComps.DashboardResponse, error)

CreateDashboard creates a dashboard.

func (*Client) CreateEventGatewayBackendCluster added in v0.3.8 

func (c *Client) CreateEventGatewayBackendCluster(
	ctx context.Context,
	gatewayID string,
	req kkComps.CreateBackendClusterRequest,
	namespace string,
) (string, error)

func (*Client) CreateEventGatewayClusterPolicy added in v0.8.0 

func (c *Client) CreateEventGatewayClusterPolicy(
	ctx context.Context,
	gatewayID string,
	virtualClusterID string,
	req kkComps.EventGatewayClusterPolicyModify,
	namespace string,
) (string, error)

func (*Client) CreateEventGatewayConsumePolicy added in v0.8.0 

func (c *Client) CreateEventGatewayConsumePolicy(
	ctx context.Context,
	gatewayID string,
	virtualClusterID string,
	req kkComps.EventGatewayConsumePolicyCreate,
	namespace string,
) (string, error)

func (*Client) CreateEventGatewayControlPlane added in v0.3.7 

func (c *Client) CreateEventGatewayControlPlane(
	ctx context.Context,
	req kkComps.CreateGatewayRequest,
	namespace string,
) (string, error)

func (*Client) CreateEventGatewayDataPlaneCertificate added in v0.6.0 

func (c *Client) CreateEventGatewayDataPlaneCertificate(
	ctx context.Context,
	gatewayID string,
	req kkComps.CreateEventGatewayDataPlaneCertificateRequest,
	namespace string,
) (string, error)

func (*Client) CreateEventGatewayListener added in v0.5.0 

func (c *Client) CreateEventGatewayListener(
	ctx context.Context,
	gatewayID string,
	req kkComps.CreateEventGatewayListenerRequest,
	namespace string,
) (string, error)

func (*Client) CreateEventGatewayListenerPolicy added in v0.5.0 

func (c *Client) CreateEventGatewayListenerPolicy(
	ctx context.Context,
	gatewayID string,
	listenerID string,
	req kkComps.EventGatewayListenerPolicyCreate,
	namespace string,
) (string, error)

func (*Client) CreateEventGatewaySchemaRegistry added in v0.8.0 

func (c *Client) CreateEventGatewaySchemaRegistry(
	ctx context.Context,
	gatewayID string,
	req kkComps.SchemaRegistryCreate,
	_ string,
) (string, error)

CreateEventGatewaySchemaRegistry creates a new schema registry for an event gateway.

func (*Client) CreateEventGatewayStaticKey added in v0.8.0 

func (c *Client) CreateEventGatewayStaticKey(
	ctx context.Context,
	gatewayID string,
	req kkComps.EventGatewayStaticKeyCreate,
	_ string,
) (string, error)

CreateEventGatewayStaticKey creates a new static key for an event gateway.

func (*Client) CreateEventGatewayTLSTrustBundle added in v0.8.0 

func (c *Client) CreateEventGatewayTLSTrustBundle(
	ctx context.Context,
	gatewayID string,
	req kkComps.CreateTLSTrustBundleRequest,
	_ string,
) (string, error)

CreateEventGatewayTLSTrustBundle creates a new TLS trust bundle for an event gateway.

func (*Client) CreateEventGatewayVirtualCluster added in v0.4.0 

func (c *Client) CreateEventGatewayVirtualCluster(
	ctx context.Context,
	gatewayID string,
	req kkComps.CreateVirtualClusterRequest,
	namespace string,
) (string, error)

func (*Client) CreateEventGatewayVirtualClusterProducePolicy added in v0.8.0 

func (c *Client) CreateEventGatewayVirtualClusterProducePolicy(
	ctx context.Context,
	gatewayID string,
	virtualClusterID string,
	req kkComps.EventGatewayProducePolicyCreate,
	namespace string,
) (string, error)

func (*Client) CreateOrganizationTeam added in v0.4.0 

func (c *Client) CreateOrganizationTeam(ctx context.Context, team *kkComps.CreateTeam,
	namespace string,
) (string, error)

func (*Client) CreatePortal 

func (c *Client) CreatePortal(
	ctx context.Context,
	portal kkComps.CreatePortal,
	namespace string,
) (*kkComps.PortalResponse, error)

CreatePortal creates a new portal with management labels

func (*Client) CreatePortalCustomDomain 

func (c *Client) CreatePortalCustomDomain(
	ctx context.Context,
	portalID string,
	req kkComps.CreatePortalCustomDomainRequest,
) error

CreatePortalCustomDomain creates a custom domain for a portal

func (*Client) CreatePortalEmailConfig added in v0.3.5 

func (c *Client) CreatePortalEmailConfig(
	ctx context.Context,
	portalID string,
	body kkComps.PostPortalEmailConfig,
) (string, error)

CreatePortalEmailConfig creates a new email configuration for a portal.

func (*Client) CreatePortalIPAllowList added in v0.10.0 

func (c *Client) CreatePortalIPAllowList(
	ctx context.Context,
	portalID string,
	req kkComps.CreatePortalSourceIPRestriction,
	namespace string,
) (string, error)

CreatePortalIPAllowList creates a portal IP allow list entry.

func (*Client) CreatePortalIdentityProvider added in v0.9.0 

func (c *Client) CreatePortalIdentityProvider(
	ctx context.Context,
	portalID string,
	body kkComps.CreateIdentityProvider,
	namespace string,
) (string, error)

CreatePortalIdentityProvider creates a new identity provider for a portal.

func (*Client) CreatePortalPage 

func (c *Client) CreatePortalPage(
	ctx context.Context,
	portalID string,
	req kkComps.CreatePortalPageRequest,
) (string, error)

CreatePortalPage creates a new page in a portal

func (*Client) CreatePortalSnippet 

func (c *Client) CreatePortalSnippet(
	ctx context.Context,
	portalID string,
	req kkComps.CreatePortalSnippetRequest,
) (string, error)

CreatePortalSnippet creates a new snippet in a portal

func (*Client) CreatePortalTeam added in v0.3.3 

func (c *Client) CreatePortalTeam(
	ctx context.Context,
	portalID string,
	req kkComps.PortalCreateTeamRequest,
	namespace string,
) (string, error)

CreatePortalTeam creates a new portal team

func (*Client) DeleteAPI 

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

DeleteAPI deletes an API by ID

func (*Client) DeleteAPIDocument 

func (c *Client) DeleteAPIDocument(ctx context.Context, apiID, documentID string) error

DeleteAPIDocument deletes an API document

func (*Client) DeleteAPIImplementation 

func (c *Client) DeleteAPIImplementation(ctx context.Context, apiID, implementationID string) error

DeleteAPIImplementation deletes an API implementation

func (*Client) DeleteAPIPublication 

func (c *Client) DeleteAPIPublication(ctx context.Context, apiID, portalID string) error

DeleteAPIPublication deletes an API publication

func (*Client) DeleteAPIVersion 

func (c *Client) DeleteAPIVersion(ctx context.Context, apiID string, versionID string) error

DeleteAPIVersion deletes an API version

func (*Client) DeleteApplicationAuthStrategy 

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

DeleteApplicationAuthStrategy deletes an auth strategy by ID

func (*Client) DeleteCatalogService added in v0.3.6 

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

DeleteCatalogService deletes a catalog service by ID.

func (*Client) DeleteControlPlane added in v0.1.6 

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

DeleteControlPlane deletes a control plane by ID

func (*Client) DeleteControlPlaneDataPlaneCertificate added in v0.10.0 

func (c *Client) DeleteControlPlaneDataPlaneCertificate(
	ctx context.Context,
	controlPlaneID string,
	certificateID string,
) error

func (*Client) DeleteDCRProvider added in v0.8.0 

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

func (*Client) DeleteDashboard added in v1.0.0 

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

DeleteDashboard deletes a dashboard by ID.

func (*Client) DeleteEventGatewayBackendCluster added in v0.3.8 

func (c *Client) DeleteEventGatewayBackendCluster(
	ctx context.Context,
	gatewayID string,
	clusterID string,
) error

func (*Client) DeleteEventGatewayClusterPolicy added in v0.8.0 

func (c *Client) DeleteEventGatewayClusterPolicy(
	ctx context.Context,
	gatewayID string,
	virtualClusterID string,
	policyID string,
) error

func (*Client) DeleteEventGatewayConsumePolicy added in v0.8.0 

func (c *Client) DeleteEventGatewayConsumePolicy(
	ctx context.Context,
	gatewayID string,
	virtualClusterID string,
	policyID string,
) error

func (*Client) DeleteEventGatewayControlPlane added in v0.3.7 

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

func (*Client) DeleteEventGatewayDataPlaneCertificate added in v0.6.0 

func (c *Client) DeleteEventGatewayDataPlaneCertificate(
	ctx context.Context,
	gatewayID string,
	certificateID string,
) error

func (*Client) DeleteEventGatewayListener added in v0.5.0 

func (c *Client) DeleteEventGatewayListener(
	ctx context.Context,
	gatewayID string,
	listenerID string,
) error

func (*Client) DeleteEventGatewayListenerPolicy added in v0.5.0 

func (c *Client) DeleteEventGatewayListenerPolicy(
	ctx context.Context,
	gatewayID string,
	listenerID string,
	policyID string,
) error

func (*Client) DeleteEventGatewaySchemaRegistry added in v0.8.0 

func (c *Client) DeleteEventGatewaySchemaRegistry(
	ctx context.Context,
	gatewayID string,
	schemaRegistryID string,
) error

DeleteEventGatewaySchemaRegistry deletes a schema registry by ID.

func (*Client) DeleteEventGatewayStaticKey added in v0.8.0 

func (c *Client) DeleteEventGatewayStaticKey(
	ctx context.Context,
	gatewayID string,
	staticKeyID string,
) error

DeleteEventGatewayStaticKey deletes a static key by ID.

func (*Client) DeleteEventGatewayTLSTrustBundle added in v0.8.0 

func (c *Client) DeleteEventGatewayTLSTrustBundle(
	ctx context.Context,
	gatewayID string,
	bundleID string,
) error

DeleteEventGatewayTLSTrustBundle deletes a TLS trust bundle by ID.

func (*Client) DeleteEventGatewayVirtualCluster added in v0.4.0 

func (c *Client) DeleteEventGatewayVirtualCluster(
	ctx context.Context,
	gatewayID string,
	clusterID string,
) error

func (*Client) DeleteEventGatewayVirtualClusterProducePolicy added in v0.8.0 

func (c *Client) DeleteEventGatewayVirtualClusterProducePolicy(
	ctx context.Context,
	gatewayID string,
	virtualClusterID string,
	policyID string,
) error

func (*Client) DeleteOrganizationTeam added in v0.4.0 

func (c *Client) DeleteOrganizationTeam(ctx context.Context, teamID string) error

func (*Client) DeletePortal 

func (c *Client) DeletePortal(ctx context.Context, id string, force bool) error

DeletePortal deletes a portal by ID

func (*Client) DeletePortalAuditLogWebhook added in v0.10.0 

func (c *Client) DeletePortalAuditLogWebhook(ctx context.Context, portalID string) error

DeletePortalAuditLogWebhook deletes the audit-log webhook configuration for a portal.

func (*Client) DeletePortalCustomDomain 

func (c *Client) DeletePortalCustomDomain(ctx context.Context, portalID string) error

DeletePortalCustomDomain deletes a portal custom domain

func (*Client) DeletePortalEmailConfig added in v0.3.5 

func (c *Client) DeletePortalEmailConfig(ctx context.Context, portalID string) error

DeletePortalEmailConfig deletes the email configuration for a portal.

func (*Client) DeletePortalEmailTemplate added in v0.3.5 

func (c *Client) DeletePortalEmailTemplate(
	ctx context.Context,
	portalID string,
	name kkComps.EmailTemplateName,
) error

DeletePortalEmailTemplate deletes a customized email template.

func (*Client) DeletePortalIPAllowList added in v0.10.0 

func (c *Client) DeletePortalIPAllowList(ctx context.Context, portalID string, id string) error

DeletePortalIPAllowList deletes a portal IP allow list entry.

func (*Client) DeletePortalIdentityProvider added in v0.9.0 

func (c *Client) DeletePortalIdentityProvider(ctx context.Context, portalID string, id string) error

DeletePortalIdentityProvider deletes an identity provider from a portal.

func (*Client) DeletePortalPage 

func (c *Client) DeletePortalPage(ctx context.Context, portalID string, pageID string) error

DeletePortalPage deletes a page from a portal

func (*Client) DeletePortalSnippet 

func (c *Client) DeletePortalSnippet(ctx context.Context, portalID string, snippetID string) error

DeletePortalSnippet deletes a snippet from a portal

func (*Client) DeletePortalTeam added in v0.3.3 

func (c *Client) DeletePortalTeam(ctx context.Context, portalID string, teamID string) error

DeletePortalTeam deletes a portal team

func (*Client) FetchAPIVersion added in v0.1.4 

func (c *Client) FetchAPIVersion(ctx context.Context, apiID, versionID string) (*APIVersion, error)

FetchAPIVersion retrieves a single API version with full content

func (*Client) GetAPIByFilter 

func (c *Client) GetAPIByFilter(ctx context.Context, filter string) (*API, error)

GetAPIByFilter finds a managed API using a filter expression

func (*Client) GetAPIByID 

func (c *Client) GetAPIByID(ctx context.Context, id string) (*API, error)

GetAPIByID finds an API by ID (for fallback during protection changes)

func (*Client) GetAPIByName 

func (c *Client) GetAPIByName(ctx context.Context, name string) (*API, error)

GetAPIByName finds a managed API by name

func (*Client) GetAPIByRef 

func (c *Client) GetAPIByRef(ctx context.Context, ref string) (*API, error)

GetAPIByRef finds a managed API by declarative ref (stored in labels) TODO: This will be replaced by filtered lookup in Phase 2

func (*Client) GetAPIDocument 

func (c *Client) GetAPIDocument(ctx context.Context, apiID, documentID string) (*APIDocument, error)

GetAPIDocument retrieves a single API document with full content

func (*Client) GetAuthStrategyByFilter 

func (c *Client) GetAuthStrategyByFilter(ctx context.Context, filter string) (*ApplicationAuthStrategy, error)

GetAuthStrategyByFilter finds a managed auth strategy using a filter expression

func (*Client) GetAuthStrategyByID added in v0.8.0 

func (c *Client) GetAuthStrategyByID(ctx context.Context, id string) (*ApplicationAuthStrategy, error)

GetAuthStrategyByID finds a managed auth strategy by ID.

func (*Client) GetAuthStrategyByName 

func (c *Client) GetAuthStrategyByName(ctx context.Context, name string) (*ApplicationAuthStrategy, error)

GetAuthStrategyByName finds a managed auth strategy by name

func (*Client) GetCatalogServiceByID added in v0.3.6 

func (c *Client) GetCatalogServiceByID(ctx context.Context, id string) (*CatalogService, error)

GetCatalogServiceByID fetches a catalog service by ID.

func (*Client) GetCatalogServiceByName added in v0.3.6 

func (c *Client) GetCatalogServiceByName(ctx context.Context, name string) (*CatalogService, error)

GetCatalogServiceByName finds a managed catalog service by name.

func (*Client) GetControlPlaneByFilter added in v0.1.6 

func (c *Client) GetControlPlaneByFilter(ctx context.Context, filter string) (*ControlPlane, error)

GetControlPlaneByFilter finds a managed control plane using a filter expression

func (*Client) GetControlPlaneByID added in v0.1.6 

func (c *Client) GetControlPlaneByID(ctx context.Context, id string) (*ControlPlane, error)

GetControlPlaneByID finds a control plane by ID (used for fallback during protection changes)

func (*Client) GetControlPlaneByName added in v0.1.6 

func (c *Client) GetControlPlaneByName(ctx context.Context, name string) (*ControlPlane, error)

GetControlPlaneByName finds a managed control plane by name

func (*Client) GetControlPlaneDataPlaneCertificate added in v0.10.0 

func (c *Client) GetControlPlaneDataPlaneCertificate(
	ctx context.Context,
	controlPlaneID string,
	certificateID string,
) (*ControlPlaneDataPlaneCertificate, error)

func (*Client) GetDCRProviderByID added in v0.8.0 

func (c *Client) GetDCRProviderByID(ctx context.Context, id string) (*DCRProvider, error)

func (*Client) GetDCRProviderByName added in v0.8.0 

func (c *Client) GetDCRProviderByName(ctx context.Context, name string) (*DCRProvider, error)

func (*Client) GetDashboardByID added in v1.0.0 

func (c *Client) GetDashboardByID(ctx context.Context, id string) (*Dashboard, error)

GetDashboardByID fetches a dashboard by ID.

func (*Client) GetEventGatewayBackendCluster added in v0.3.8 

func (c *Client) GetEventGatewayBackendCluster(
	ctx context.Context,
	gatewayID string,
	clusterID string,
) (*EventGatewayBackendCluster, error)

func (*Client) GetEventGatewayBackendClusterByName added in v0.4.0 

func (c *Client) GetEventGatewayBackendClusterByName(
	ctx context.Context, gatewayID string, name string,
) (*EventGatewayBackendCluster, error)

func (*Client) GetEventGatewayClusterPolicy added in v0.8.0 

func (c *Client) GetEventGatewayClusterPolicy(
	ctx context.Context,
	gatewayID string,
	virtualClusterID string,
	policyID string,
) (*EventGatewayClusterPolicyInfo, error)

func (*Client) GetEventGatewayConsumePolicy added in v0.8.0 

func (c *Client) GetEventGatewayConsumePolicy(
	ctx context.Context,
	gatewayID string,
	virtualClusterID string,
	policyID string,
) (*EventGatewayConsumePolicyInfo, error)

func (*Client) GetEventGatewayControlPlaneByID added in v0.3.7 

func (c *Client) GetEventGatewayControlPlaneByID(ctx context.Context, id string) (*EventGatewayControlPlane, error)

func (*Client) GetEventGatewayControlPlaneByName added in v0.3.8 

func (c *Client) GetEventGatewayControlPlaneByName(
	ctx context.Context, name string,
) (*EventGatewayControlPlane, error)

func (*Client) GetEventGatewayDataPlaneCertificate added in v0.6.0 

func (c *Client) GetEventGatewayDataPlaneCertificate(
	ctx context.Context,
	gatewayID string,
	certificateID string,
) (*EventGatewayDataPlaneCertificate, error)

func (*Client) GetEventGatewayListener added in v0.5.0 

func (c *Client) GetEventGatewayListener(
	ctx context.Context,
	gatewayID string,
	listenerID string,
) (*EventGatewayListener, error)

func (*Client) GetEventGatewayListenerPolicy added in v0.5.0 

func (c *Client) GetEventGatewayListenerPolicy(
	ctx context.Context,
	gatewayID string,
	listenerID string,
	policyID string,
) (*EventGatewayListenerPolicyInfo, error)

func (*Client) GetEventGatewaySchemaRegistryByID added in v0.8.0 

func (c *Client) GetEventGatewaySchemaRegistryByID(
	ctx context.Context,
	gatewayID string,
	schemaRegistryID string,
) (*EventGatewaySchemaRegistry, error)

GetEventGatewaySchemaRegistryByID retrieves a single schema registry by ID.

func (*Client) GetEventGatewaySchemaRegistryByName added in v0.8.0 

func (c *Client) GetEventGatewaySchemaRegistryByName(
	ctx context.Context,
	gatewayID string,
	name string,
) (*EventGatewaySchemaRegistry, error)

GetEventGatewaySchemaRegistryByName looks up a schema registry by name.

func (*Client) GetEventGatewayStaticKey added in v0.8.0 

func (c *Client) GetEventGatewayStaticKey(
	ctx context.Context,
	gatewayID string,
	staticKeyID string,
) (*EventGatewayStaticKey, error)

GetEventGatewayStaticKey retrieves a static key by ID.

func (*Client) GetEventGatewayTLSTrustBundle added in v0.8.0 

func (c *Client) GetEventGatewayTLSTrustBundle(
	ctx context.Context,
	gatewayID string,
	bundleID string,
) (*EventGatewayTLSTrustBundle, error)

GetEventGatewayTLSTrustBundle retrieves a TLS trust bundle by ID.

func (*Client) GetEventGatewayVirtualCluster added in v0.4.0 

func (c *Client) GetEventGatewayVirtualCluster(
	ctx context.Context,
	gatewayID string,
	clusterID string,
) (*EventGatewayVirtualCluster, error)

func (*Client) GetEventGatewayVirtualClusterByName added in v0.5.0 

func (c *Client) GetEventGatewayVirtualClusterByName(
	ctx context.Context,
	gatewayID string,
	name string,
) (*EventGatewayVirtualCluster, error)

GetEventGatewayVirtualClusterByName retrieves a virtual cluster by name within a gateway

func (*Client) GetEventGatewayVirtualClusterProducePolicy added in v0.8.0 

func (c *Client) GetEventGatewayVirtualClusterProducePolicy(
	ctx context.Context,
	gatewayID string,
	virtualClusterID string,
	policyID string,
) (*EventGatewayVirtualClusterProducePolicyInfo, error)

func (*Client) GetOrganizationSystemAccount added in v1.0.0 

func (c *Client) GetOrganizationSystemAccount(
	ctx context.Context,
	accountID string,
) (*OrganizationSystemAccount, error)

GetOrganizationSystemAccount returns a system account by ID.

func (*Client) GetOrganizationTeamByID added in v0.4.0 

func (c *Client) GetOrganizationTeamByID(ctx context.Context, id string) (*OrganizationTeam, error)

func (*Client) GetOrganizationTeamByName added in v0.4.0 

func (c *Client) GetOrganizationTeamByName(ctx context.Context, name string) (*OrganizationTeam, error)

GetOrganizationTeamByName finds a managed organization team by name

func (*Client) GetOrganizationTeamByNameUnfiltered added in v1.0.0 

func (c *Client) GetOrganizationTeamByNameUnfiltered(ctx context.Context, name string) (*OrganizationTeam, error)

GetOrganizationTeamByNameUnfiltered finds an organization team by name without requiring kongctl-managed labels.

func (*Client) GetOrganizationUser added in v1.0.0 

func (c *Client) GetOrganizationUser(ctx context.Context, userID string) (*OrganizationUser, error)

GetOrganizationUser returns a user by ID.

func (*Client) GetPortalAssetFavicon added in v0.3.5 

func (c *Client) GetPortalAssetFavicon(ctx context.Context, portalID string) (string, error)

GetPortalAssetFavicon fetches the favicon for a portal as a data URL 

func (c *Client) GetPortalAssetLogo(ctx context.Context, portalID string) (string, error)

GetPortalAssetLogo fetches the logo for a portal as a data URL

func (*Client) GetPortalAuditLogWebhook added in v0.10.0 

func (c *Client) GetPortalAuditLogWebhook(
	ctx context.Context,
	portalID string,
) (*kkComps.PortalAuditLogWebhook, error)

GetPortalAuditLogWebhook fetches the current audit-log webhook configuration for a portal.

func (*Client) GetPortalAuthSettings added in v0.3.4 

func (c *Client) GetPortalAuthSettings(
	ctx context.Context,
	portalID string,
) (*kkComps.PortalAuthenticationSettingsResponse, error)

GetPortalAuthSettings fetches current auth settings for a portal.

func (*Client) GetPortalByFilter 

func (c *Client) GetPortalByFilter(ctx context.Context, filter string) (*Portal, error)

GetPortalByFilter finds a managed portal using a filter expression

func (*Client) GetPortalByName 

func (c *Client) GetPortalByName(ctx context.Context, name string) (*Portal, error)

GetPortalByName finds a managed portal by name

func (*Client) GetPortalCustomDomain added in v0.3.3 

func (c *Client) GetPortalCustomDomain(ctx context.Context, portalID string) (*PortalCustomDomain, error)

GetPortalCustomDomain fetches the current custom domain for a portal.

func (*Client) GetPortalCustomEmailTemplate added in v0.3.5 

func (c *Client) GetPortalCustomEmailTemplate(
	ctx context.Context,
	portalID string,
	name kkComps.EmailTemplateName,
) (*PortalEmailTemplate, error)

GetPortalCustomEmailTemplate fetches a single customized email template.

func (*Client) GetPortalCustomization 

func (c *Client) GetPortalCustomization(
	ctx context.Context,
	portalID string,
) (*kkComps.PortalCustomization, error)

GetPortalCustomization fetches the current customization for a portal

func (*Client) GetPortalEmailConfig added in v0.3.5 

func (c *Client) GetPortalEmailConfig(ctx context.Context, portalID string) (*kkComps.PortalEmailConfig, error)

GetPortalEmailConfig fetches the current email configuration for a portal.

func (*Client) GetPortalIPAllowList added in v0.10.0 

func (c *Client) GetPortalIPAllowList(ctx context.Context, portalID string, id string) (*PortalIPAllowList, error)

GetPortalIPAllowList fetches a portal IP allow list entry by ID.

func (*Client) GetPortalIdentityProvider added in v0.9.0 

func (c *Client) GetPortalIdentityProvider(
	ctx context.Context,
	portalID string,
	id string,
) (*PortalIdentityProvider, error)

GetPortalIdentityProvider fetches a single identity provider for a portal.

func (*Client) GetPortalIntegrations added in v0.10.0 

func (c *Client) GetPortalIntegrations(ctx context.Context, portalID string) (*kkComps.PortalIntegrations, error)

GetPortalIntegrations fetches current integration configuration for a portal.

func (*Client) GetPortalPage 

func (c *Client) GetPortalPage(ctx context.Context, portalID string, pageID string) (*PortalPage, error)

GetPortalPage fetches a single portal page with full details including content

func (*Client) GetPortalSnippet 

func (c *Client) GetPortalSnippet(ctx context.Context, portalID string, snippetID string) (*PortalSnippet, error)

GetPortalSnippet fetches a single portal snippet with full details including content

func (*Client) ListAPIDocuments 

func (c *Client) ListAPIDocuments(ctx context.Context, apiID string) ([]APIDocument, error)

ListAPIDocuments returns all documents for an API

func (*Client) ListAPIImplementations 

func (c *Client) ListAPIImplementations(ctx context.Context, apiID string) ([]APIImplementation, error)

ListAPIImplementations returns all implementations for an API

func (*Client) ListAPIPublications 

func (c *Client) ListAPIPublications(ctx context.Context, apiID string) ([]APIPublication, error)

ListAPIPublications returns all publications for an API

func (*Client) ListAPIVersions 

func (c *Client) ListAPIVersions(ctx context.Context, apiID string) ([]APIVersion, error)

ListAPIVersions returns all versions for an API

func (*Client) ListAllAPIs 

func (c *Client) ListAllAPIs(ctx context.Context) ([]API, error)

ListAllAPIs returns all APIs without managed filtering (for fallback lookups)

func (*Client) ListAllControlPlanes added in v0.1.6 

func (c *Client) ListAllControlPlanes(ctx context.Context) ([]ControlPlane, error)

ListAllControlPlanes returns all control planes, including non-managed ones

func (*Client) ListAllPortals added in v0.1.5 

func (c *Client) ListAllPortals(ctx context.Context) ([]Portal, error)

ListAllPortals returns all portals, including non-managed ones

func (*Client) ListAuditLogWebhookDestinations added in v0.10.0 

func (c *Client) ListAuditLogWebhookDestinations(ctx context.Context) ([]AuditLogWebhookDestination, error)

ListAuditLogWebhookDestinations returns organization audit-log webhook destinations.

func (*Client) ListControlPlaneDataPlaneCertificates added in v0.10.0 

func (c *Client) ListControlPlaneDataPlaneCertificates(
	ctx context.Context,
	controlPlaneID string,
) ([]ControlPlaneDataPlaneCertificate, error)

func (*Client) ListControlPlaneGroupMemberships added in v0.3.0 

func (c *Client) ListControlPlaneGroupMemberships(ctx context.Context, groupID string) ([]string, error)

ListControlPlaneGroupMemberships returns all child control plane IDs for a control plane group.

func (*Client) ListEventGatewayBackendClusters added in v0.3.8 

func (c *Client) ListEventGatewayBackendClusters(
	ctx context.Context,
	gatewayID string,
) ([]EventGatewayBackendCluster, error)

func (*Client) ListEventGatewayClusterPolicies added in v0.8.0 

func (c *Client) ListEventGatewayClusterPolicies(
	ctx context.Context,
	gatewayID string,
	virtualClusterID string,
) ([]EventGatewayClusterPolicyInfo, error)

func (*Client) ListEventGatewayConsumePolicies added in v0.8.0 

func (c *Client) ListEventGatewayConsumePolicies(
	ctx context.Context,
	gatewayID string,
	virtualClusterID string,
) ([]EventGatewayConsumePolicyInfo, error)

func (*Client) ListEventGatewayDataPlaneCertificates added in v0.6.0 

func (c *Client) ListEventGatewayDataPlaneCertificates(
	ctx context.Context,
	gatewayID string,
) ([]EventGatewayDataPlaneCertificate, error)

func (*Client) ListEventGatewayListenerPolicies added in v0.5.0 

func (c *Client) ListEventGatewayListenerPolicies(
	ctx context.Context,
	gatewayID string,
	listenerID string,
) ([]EventGatewayListenerPolicyInfo, error)

func (*Client) ListEventGatewayListeners added in v0.5.0 

func (c *Client) ListEventGatewayListeners(
	ctx context.Context,
	gatewayID string,
) ([]EventGatewayListener, error)

func (*Client) ListEventGatewaySchemaRegistries added in v0.8.0 

func (c *Client) ListEventGatewaySchemaRegistries(
	ctx context.Context,
	gatewayID string,
) ([]EventGatewaySchemaRegistry, error)

ListEventGatewaySchemaRegistries returns all schema registries for a given event gateway. It uses cursor-based pagination to retrieve all pages.

func (*Client) ListEventGatewayStaticKeys added in v0.8.0 

func (c *Client) ListEventGatewayStaticKeys(
	ctx context.Context,
	gatewayID string,
) ([]EventGatewayStaticKey, error)

ListEventGatewayStaticKeys lists all static keys for a gateway using cursor-based pagination.

func (*Client) ListEventGatewayTLSTrustBundles added in v0.8.0 

func (c *Client) ListEventGatewayTLSTrustBundles(
	ctx context.Context,
	gatewayID string,
) ([]EventGatewayTLSTrustBundle, error)

ListEventGatewayTLSTrustBundles lists all TLS trust bundles for a gateway using cursor-based pagination.

func (*Client) ListEventGatewayVirtualClusterProducePolicies added in v0.8.0 

func (c *Client) ListEventGatewayVirtualClusterProducePolicies(
	ctx context.Context,
	gatewayID string,
	virtualClusterID string,
) ([]EventGatewayVirtualClusterProducePolicyInfo, error)

func (*Client) ListEventGatewayVirtualClusters added in v0.4.0 

func (c *Client) ListEventGatewayVirtualClusters(
	ctx context.Context,
	gatewayID string,
) ([]EventGatewayVirtualCluster, error)

func (*Client) ListGatewayServices added in v0.2.0 

func (c *Client) ListGatewayServices(ctx context.Context, controlPlaneID string) ([]GatewayService, error)

ListGatewayServices returns all gateway services for the provided control plane.

func (*Client) ListManagedAPIs 

func (c *Client) ListManagedAPIs(ctx context.Context, namespaces []string) ([]API, error)

ListManagedAPIs returns all KONGCTL-managed APIs in the specified namespaces If namespaces is empty, no resources are returned (breaking change from previous behavior) To get all managed resources across all namespaces, pass []string{"*"}

func (*Client) ListManagedAuthStrategies 

func (c *Client) ListManagedAuthStrategies(
	ctx context.Context, namespaces []string,
) ([]ApplicationAuthStrategy, error)

ListManagedAuthStrategies returns all KONGCTL-managed auth strategies in the specified namespaces If namespaces is empty, no resources are returned (breaking change from previous behavior) To get all managed resources across all namespaces, pass []string{"*"}

func (*Client) ListManagedCatalogServices added in v0.3.6 

func (c *Client) ListManagedCatalogServices(ctx context.Context, namespaces []string) ([]CatalogService, error)

ListManagedCatalogServices returns all KONGCTL-managed catalog services in the specified namespaces. If namespaces is empty, no resources are returned. To get all managed resources, pass []string{"*"}.

func (*Client) ListManagedControlPlanes added in v0.1.6 

func (c *Client) ListManagedControlPlanes(ctx context.Context, namespaces []string) ([]ControlPlane, error)

ListManagedControlPlanes returns all KONGCTL-managed control planes in the specified namespaces If namespaces is empty, no resources are returned (breaking change from previous behavior) To get all managed resources across all namespaces, pass []string{"*"}

func (*Client) ListManagedDCRProviders added in v0.8.0 

func (c *Client) ListManagedDCRProviders(
	ctx context.Context, namespaces []string,
) ([]DCRProvider, error)

ListManagedDCRProviders returns all KONGCTL-managed DCR providers in the specified namespaces.

func (*Client) ListManagedDashboards added in v1.0.0 

func (c *Client) ListManagedDashboards(ctx context.Context, namespaces []string) ([]Dashboard, error)

ListManagedDashboards returns all KONGCTL-managed dashboards in the specified namespaces. If namespaces is empty, no resources are returned. To get all managed resources, pass []string{"*"}.

func (*Client) ListManagedEventGatewayControlPlanes added in v0.3.7 

func (c *Client) ListManagedEventGatewayControlPlanes(
	ctx context.Context,
	namespaces []string,
) ([]EventGatewayControlPlane, error)

func (*Client) ListManagedOrganizationTeams added in v0.4.0 

func (c *Client) ListManagedOrganizationTeams(ctx context.Context, namespaces []string) ([]OrganizationTeam, error)

func (*Client) ListManagedPortalPages 

func (c *Client) ListManagedPortalPages(ctx context.Context, portalID string) ([]PortalPage, error)

ListManagedPortalPages returns all KONGCTL-managed portal pages for a portal

func (*Client) ListManagedPortals 

func (c *Client) ListManagedPortals(ctx context.Context, namespaces []string) ([]Portal, error)

ListManagedPortals returns all KONGCTL-managed portals in the specified namespaces If namespaces is empty, no resources are returned (breaking change from previous behavior) To get all managed resources across all namespaces, pass []string{"*"}

func (*Client) ListOrganizationSystemAccountRoles added in v1.0.0 

func (c *Client) ListOrganizationSystemAccountRoles(
	ctx context.Context,
	accountID string,
) ([]OrganizationSystemAccountRole, error)

ListOrganizationSystemAccountRoles returns all assigned roles for an organization system account.

func (*Client) ListOrganizationSystemAccountTeams added in v1.0.0 

func (c *Client) ListOrganizationSystemAccountTeams(
	ctx context.Context,
	accountID string,
) ([]OrganizationSystemAccountTeamMembership, error)

ListOrganizationSystemAccountTeams returns all teams for a system account.

func (*Client) ListOrganizationSystemAccounts added in v1.0.0 

func (c *Client) ListOrganizationSystemAccounts(ctx context.Context) ([]OrganizationSystemAccount, error)

ListOrganizationSystemAccounts returns all organization system accounts.

func (*Client) ListOrganizationTeamRoles added in v1.0.0 

func (c *Client) ListOrganizationTeamRoles(ctx context.Context, teamID string) ([]OrganizationTeamRole, error)

ListOrganizationTeamRoles returns all assigned roles for an organization team.

func (*Client) ListOrganizationTeamUsers added in v1.0.0 

func (c *Client) ListOrganizationTeamUsers(
	ctx context.Context,
	teamID string,
) ([]OrganizationUserTeamMembership, error)

ListOrganizationTeamUsers returns all users for a team.

func (*Client) ListOrganizationUserRoles added in v1.0.0 

func (c *Client) ListOrganizationUserRoles(ctx context.Context, userID string) ([]OrganizationUserRole, error)

ListOrganizationUserRoles returns all assigned roles for an organization user.

func (*Client) ListOrganizationUserTeams added in v1.0.0 

func (c *Client) ListOrganizationUserTeams(
	ctx context.Context,
	userID string,
) ([]OrganizationUserTeamMembership, error)

ListOrganizationUserTeams returns all teams for a user.

func (*Client) ListOrganizationUsers added in v1.0.0 

func (c *Client) ListOrganizationUsers(ctx context.Context) ([]OrganizationUser, error)

ListOrganizationUsers returns all organization users.

func (*Client) ListPortalCustomEmailTemplates added in v0.3.5 

func (c *Client) ListPortalCustomEmailTemplates(ctx context.Context, portalID string) ([]PortalEmailTemplate, error)

ListPortalCustomEmailTemplates returns customized templates for a portal.

func (*Client) ListPortalIPAllowLists added in v0.10.0 

func (c *Client) ListPortalIPAllowLists(ctx context.Context, portalID string) ([]PortalIPAllowList, error)

ListPortalIPAllowLists lists all IP allow list entries for a portal.

func (*Client) ListPortalIdentityProviders added in v0.9.0 

func (c *Client) ListPortalIdentityProviders(ctx context.Context, portalID string) ([]PortalIdentityProvider, error)

ListPortalIdentityProviders returns all identity providers for a portal.

func (*Client) ListPortalSnippets 

func (c *Client) ListPortalSnippets(ctx context.Context, portalID string) ([]PortalSnippet, error)

ListPortalSnippets returns all snippets for a portal

func (*Client) ListPortalTeamGroupMappings added in v1.0.0 

func (c *Client) ListPortalTeamGroupMappings(ctx context.Context, portalID string) ([]PortalTeamGroupMapping, error)

ListPortalTeamGroupMappings returns all team group mappings for a portal.

func (*Client) ListPortalTeamRoles added in v0.3.4 

func (c *Client) ListPortalTeamRoles(ctx context.Context, portalID string, teamID string) ([]PortalTeamRole, error)

ListPortalTeamRoles returns all assigned roles for a portal team

func (*Client) ListPortalTeams added in v0.3.3 

func (c *Client) ListPortalTeams(ctx context.Context, portalID string) ([]PortalTeam, error)

ListPortalTeams returns all teams for a portal

func (*Client) RemoveOrganizationSystemAccountFromTeam added in v1.0.0 

func (c *Client) RemoveOrganizationSystemAccountFromTeam(ctx context.Context, accountID string, teamID string) error

RemoveOrganizationSystemAccountFromTeam removes a system account from an organization team.

func (*Client) RemoveOrganizationSystemAccountRole added in v1.0.0 

func (c *Client) RemoveOrganizationSystemAccountRole(ctx context.Context, accountID string, roleID string) error

RemoveOrganizationSystemAccountRole removes an assigned role from an organization system account.

func (*Client) RemoveOrganizationTeamRole added in v1.0.0 

func (c *Client) RemoveOrganizationTeamRole(ctx context.Context, teamID string, roleID string) error

RemoveOrganizationTeamRole removes an assigned role from an organization team.

func (*Client) RemoveOrganizationUserFromTeam added in v1.0.0 

func (c *Client) RemoveOrganizationUserFromTeam(ctx context.Context, userID string, teamID string) error

RemoveOrganizationUserFromTeam removes a user from an organization team.

func (*Client) RemoveOrganizationUserRole added in v1.0.0 

func (c *Client) RemoveOrganizationUserRole(ctx context.Context, userID string, roleID string) error

RemoveOrganizationUserRole removes an assigned role from an organization user.

func (*Client) RemovePortalTeamRole added in v0.3.4 

func (c *Client) RemovePortalTeamRole(ctx context.Context, portalID string, teamID string, roleID string) error

RemovePortalTeamRole removes an assigned role from a portal team

func (*Client) ReplacePortalAssetFavicon added in v0.3.5 

func (c *Client) ReplacePortalAssetFavicon(ctx context.Context, portalID, dataURL string) error

ReplacePortalAssetFavicon uploads a new favicon for a portal 

func (c *Client) ReplacePortalAssetLogo(ctx context.Context, portalID, dataURL string) error

ReplacePortalAssetLogo uploads a new logo for a portal

func (*Client) UpdateAPI 

func (c *Client) UpdateAPI(
	ctx context.Context,
	id string,
	api kkComps.UpdateAPIRequest,
	_ string,
) (*kkComps.APIResponseSchema, error)

UpdateAPI updates an existing API with new management labels

func (*Client) UpdateAPIDocument 

func (c *Client) UpdateAPIDocument(
	ctx context.Context, apiID, documentID string, document kkComps.APIDocument,
) (*kkComps.APIDocumentResponse, error)

UpdateAPIDocument updates an existing API document

func (*Client) UpdateAPIVersion added in v0.1.4 

func (c *Client) UpdateAPIVersion(
	ctx context.Context, apiID, versionID string, version kkComps.APIVersionRequest,
) (*kkComps.APIVersionResponse, error)

UpdateAPIVersion updates an existing API version

func (*Client) UpdateApplicationAuthStrategy 

func (c *Client) UpdateApplicationAuthStrategy(
	ctx context.Context,
	id string,
	authStrategy kkComps.UpdateAppAuthStrategyRequest,
	_ string,
) (*kkOps.UpdateAppAuthStrategyResponse, error)

UpdateApplicationAuthStrategy updates an existing auth strategy with new management labels

func (*Client) UpdateCatalogService added in v0.3.6 

func (c *Client) UpdateCatalogService(
	ctx context.Context,
	id string,
	req kkComps.UpdateCatalogService,
	namespace string,
) (*kkComps.CatalogService, error)

UpdateCatalogService updates an existing catalog service.

func (*Client) UpdateControlPlane added in v0.1.6 

func (c *Client) UpdateControlPlane(
	ctx context.Context,
	id string,
	controlPlane kkComps.UpdateControlPlaneRequest,
	namespace string,
) (*kkComps.ControlPlane, error)

UpdateControlPlane updates an existing control plane

func (*Client) UpdateDCRProvider added in v0.8.0 

func (c *Client) UpdateDCRProvider(
	ctx context.Context,
	id string,
	provider kkComps.UpdateDcrProviderRequest,
	_ string,
) error

func (*Client) UpdateDashboard added in v1.0.0 

func (c *Client) UpdateDashboard(
	ctx context.Context,
	id string,
	req kkComps.DashboardUpdateRequest,
	namespace string,
) (*kkComps.DashboardResponse, error)

UpdateDashboard updates a dashboard.

func (*Client) UpdateEventGatewayBackendCluster added in v0.3.8 

func (c *Client) UpdateEventGatewayBackendCluster(
	ctx context.Context,
	gatewayID string,
	clusterID string,
	req kkComps.UpdateBackendClusterRequest,
	namespace string,
) (string, error)

func (*Client) UpdateEventGatewayClusterPolicy added in v0.8.0 

func (c *Client) UpdateEventGatewayClusterPolicy(
	ctx context.Context,
	gatewayID string,
	virtualClusterID string,
	policyID string,
	req kkComps.EventGatewayClusterPolicyModify,
	namespace string,
) (string, error)

func (*Client) UpdateEventGatewayConsumePolicy added in v0.8.0 

func (c *Client) UpdateEventGatewayConsumePolicy(
	ctx context.Context,
	gatewayID string,
	virtualClusterID string,
	policyID string,
	req kkComps.EventGatewayConsumePolicyUpdate,
	namespace string,
) (string, error)

func (*Client) UpdateEventGatewayControlPlane added in v0.3.7 

func (c *Client) UpdateEventGatewayControlPlane(
	ctx context.Context,
	id string,
	req kkComps.UpdateGatewayRequest,
	namespace string,
) (string, error)

func (*Client) UpdateEventGatewayDataPlaneCertificate added in v0.6.0 

func (c *Client) UpdateEventGatewayDataPlaneCertificate(
	ctx context.Context,
	gatewayID string,
	certificateID string,
	req kkComps.UpdateEventGatewayDataPlaneCertificateRequest,
	namespace string,
) (string, error)

func (*Client) UpdateEventGatewayListener added in v0.5.0 

func (c *Client) UpdateEventGatewayListener(
	ctx context.Context,
	gatewayID string,
	listenerID string,
	req kkComps.UpdateEventGatewayListenerRequest,
	namespace string,
) (string, error)

func (*Client) UpdateEventGatewayListenerPolicy added in v0.5.0 

func (c *Client) UpdateEventGatewayListenerPolicy(
	ctx context.Context,
	gatewayID string,
	listenerID string,
	policyID string,
	req kkComps.EventGatewayListenerPolicyUpdate,
	namespace string,
) (string, error)

func (*Client) UpdateEventGatewaySchemaRegistry added in v0.8.0 

func (c *Client) UpdateEventGatewaySchemaRegistry(
	ctx context.Context,
	gatewayID string,
	schemaRegistryID string,
	req kkComps.SchemaRegistryUpdate,
	_ string,
) (string, error)

UpdateEventGatewaySchemaRegistry updates an existing schema registry.

func (*Client) UpdateEventGatewayTLSTrustBundle added in v0.8.0 

func (c *Client) UpdateEventGatewayTLSTrustBundle(
	ctx context.Context,
	gatewayID string,
	bundleID string,
	req kkComps.UpdateTLSTrustBundleRequest,
	_ string,
) (string, error)

UpdateEventGatewayTLSTrustBundle updates a TLS trust bundle.

func (*Client) UpdateEventGatewayVirtualCluster added in v0.4.0 

func (c *Client) UpdateEventGatewayVirtualCluster(
	ctx context.Context,
	gatewayID string,
	clusterID string,
	req kkComps.UpdateVirtualClusterRequest,
	namespace string,
) (string, error)

func (*Client) UpdateEventGatewayVirtualClusterProducePolicy added in v0.8.0 

func (c *Client) UpdateEventGatewayVirtualClusterProducePolicy(
	ctx context.Context,
	gatewayID string,
	virtualClusterID string,
	policyID string,
	req kkComps.EventGatewayProducePolicyUpdate,
	namespace string,
) (string, error)

func (*Client) UpdateOrganizationTeam added in v0.4.0 

func (c *Client) UpdateOrganizationTeam(ctx context.Context, teamID string,
	team *kkComps.UpdateTeam, namespace string,
) (string, error)

func (*Client) UpdatePortal 

func (c *Client) UpdatePortal(
	ctx context.Context,
	id string,
	portal kkComps.UpdatePortal,
	_ string,
) (*kkComps.PortalResponse, error)

UpdatePortal updates an existing portal with new management labels

func (*Client) UpdatePortalAuditLogWebhook added in v0.10.0 

func (c *Client) UpdatePortalAuditLogWebhook(
	ctx context.Context,
	portalID string,
	body *kkComps.UpdatePortalAuditLogWebhook,
) (string, error)

UpdatePortalAuditLogWebhook updates the audit-log webhook configuration for a portal.

func (*Client) UpdatePortalAuthSettings added in v0.3.4 

func (c *Client) UpdatePortalAuthSettings(
	ctx context.Context,
	portalID string,
	settings kkComps.PortalAuthenticationSettingsUpdateRequest,
) error

UpdatePortalAuthSettings updates portal authentication settings.

func (*Client) UpdatePortalCustomDomain 

func (c *Client) UpdatePortalCustomDomain(
	ctx context.Context,
	portalID string,
	req kkComps.UpdatePortalCustomDomainRequest,
) error

UpdatePortalCustomDomain updates a portal custom domain

func (*Client) UpdatePortalCustomization 

func (c *Client) UpdatePortalCustomization(
	ctx context.Context,
	portalID string,
	customization kkComps.PortalCustomization,
) error

UpdatePortalCustomization updates portal customization settings

func (*Client) UpdatePortalEmailConfig added in v0.3.5 

func (c *Client) UpdatePortalEmailConfig(
	ctx context.Context,
	portalID string,
	body *kkComps.PatchPortalEmailConfig,
) (string, error)

UpdatePortalEmailConfig updates the email configuration for a portal.

func (*Client) UpdatePortalEmailTemplate added in v0.3.5 

func (c *Client) UpdatePortalEmailTemplate(
	ctx context.Context,
	portalID string,
	name kkComps.EmailTemplateName,
	payload kkComps.PatchCustomPortalEmailTemplatePayload,
) (string, error)

UpdatePortalEmailTemplate creates or updates a customized email template.

func (*Client) UpdatePortalIPAllowList added in v0.10.0 

func (c *Client) UpdatePortalIPAllowList(
	ctx context.Context,
	portalID string,
	id string,
	req kkComps.UpdatePortalSourceIPRestriction,
	namespace string,
) (string, error)

UpdatePortalIPAllowList updates a portal IP allow list entry.

func (*Client) UpdatePortalIdentityProvider added in v0.9.0 

func (c *Client) UpdatePortalIdentityProvider(
	ctx context.Context,
	portalID string,
	id string,
	body kkComps.UpdateIdentityProvider,
	namespace string,
) error

UpdatePortalIdentityProvider updates an identity provider for a portal.

func (*Client) UpdatePortalPage 

func (c *Client) UpdatePortalPage(
	ctx context.Context,
	portalID string,
	pageID string,
	req kkComps.UpdatePortalPageRequest,
) error

UpdatePortalPage updates an existing page in a portal

func (*Client) UpdatePortalSnippet 

func (c *Client) UpdatePortalSnippet(
	ctx context.Context,
	portalID string,
	snippetID string,
	req kkComps.UpdatePortalSnippetRequest,
) error

UpdatePortalSnippet updates an existing snippet in a portal

func (*Client) UpdatePortalTeam added in v0.3.3 

func (c *Client) UpdatePortalTeam(
	ctx context.Context,
	portalID string,
	teamID string,
	req kkComps.PortalUpdateTeamRequest,
	namespace string,
) error

UpdatePortalTeam updates a portal team

func (*Client) UpdatePortalTeamGroupMapping added in v1.0.0 

func (c *Client) UpdatePortalTeamGroupMapping(
	ctx context.Context,
	portalID string,
	teamID string,
	groups []string,
) error

UpdatePortalTeamGroupMapping replaces one team's IdP group list.

func (*Client) UpsertControlPlaneGroupMemberships added in v0.3.0 

func (c *Client) UpsertControlPlaneGroupMemberships(ctx context.Context, groupID string, memberIDs []string) error

UpsertControlPlaneGroupMemberships replaces the members of a control plane group.

func (*Client) UpsertPortalIntegrations added in v0.10.0 

func (c *Client) UpsertPortalIntegrations(
	ctx context.Context,
	portalID string,
	integrations kkComps.PortalIntegrations,
) error

UpsertPortalIntegrations replaces portal integration configuration.

func (*Client) ValidatePortalIPAllowListAPI added in v0.10.0 

func (c *Client) ValidatePortalIPAllowListAPI() error

ValidatePortalIPAllowListAPI returns an error if the portal IP allow list API is not configured.

type ClientConfig 

type ClientConfig struct {
	// Core APIs
	PortalAPI               helpers.PortalAPI
	APIAPI                  helpers.APIAPI
	AppAuthAPI              helpers.AppAuthStrategiesAPI
	DCRProviderAPI          helpers.DCRProvidersAPI
	ControlPlaneAPI         helpers.ControlPlaneAPI
	GatewayServiceAPI       helpers.GatewayServiceAPI
	DataPlaneCertificateAPI helpers.DataPlaneCertificateAPI
	ControlPlaneGroupsAPI   helpers.ControlPlaneGroupsAPI
	CatalogServiceAPI       helpers.CatalogServicesAPI
	DashboardsAPI           helpers.DashboardsAPI

	// Portal child resource APIs
	PortalPageAPI             helpers.PortalPageAPI
	PortalAuthSettingsAPI     helpers.PortalAuthSettingsAPI
	PortalIPAllowListAPI      helpers.PortalIPAllowListAPI
	PortalIntegrationsAPI     helpers.PortalIntegrationsAPI
	PortalIdentityProviderAPI helpers.PortalIdentityProviderAPI
	PortalCustomizationAPI    helpers.PortalCustomizationAPI
	PortalCustomDomainAPI     helpers.PortalCustomDomainAPI
	PortalSnippetAPI          helpers.PortalSnippetAPI
	PortalTeamAPI             helpers.PortalTeamAPI
	PortalTeamRolesAPI        helpers.PortalTeamRolesAPI
	PortalEmailsAPI           helpers.PortalEmailsAPI
	PortalAuditLogsAPI        helpers.PortalAuditLogsAPI
	AssetsAPI                 helpers.AssetsAPI

	// Organization-scoped support resources
	AuditLogDestinationsAPI helpers.AuditLogDestinationsAPI

	// API child resource APIs
	APIVersionAPI        helpers.APIVersionAPI
	APIPublicationAPI    helpers.APIPublicationAPI
	APIImplementationAPI helpers.APIImplementationAPI
	APIDocumentAPI       helpers.APIDocumentAPI

	// Event Gateway APIs
	EGWControlPlaneAPI                  helpers.EGWControlPlaneAPI
	EventGatewayBackendClusterAPI       helpers.EventGatewayBackendClusterAPI
	EventGatewayVirtualClusterAPI       helpers.EventGatewayVirtualClusterAPI
	EventGatewayListenerAPI             helpers.EventGatewayListenerAPI
	EventGatewayListenerPolicyAPI       helpers.EventGatewayListenerPolicyAPI
	EventGatewayClusterPolicyAPI        helpers.EventGatewayClusterPolicyAPI
	EventGatewayProducePolicyAPI        helpers.EventGatewayProducePolicyAPI
	EventGatewayConsumePolicyAPI        helpers.EventGatewayConsumePolicyAPI
	EventGatewayDataPlaneCertificateAPI helpers.EventGatewayDataPlaneCertificateAPI
	EventGatewaySchemaRegistryAPI       helpers.EventGatewaySchemaRegistryAPI
	EventGatewayStaticKeyAPI            helpers.EventGatewayStaticKeyAPI
	EventGatewayTLSTrustBundleAPI       helpers.EventGatewayTLSTrustBundleAPI

	// Identity resources
	OrganizationTeamAPI        helpers.OrganizationTeamAPI
	OrganizationTeamRolesAPI   helpers.OrganizationTeamRolesAPI
	OrganizationUsersAPI       helpers.OrganizationUsersAPI
	OrganizationMembershipAPI  helpers.OrganizationTeamMembershipAPI
	SystemAccountAPI           helpers.SystemAccountAPI
	SystemAccountRolesAPI      helpers.SystemAccountRolesAPI
	SystemAccountMembershipAPI helpers.SystemAccountTeamMembershipAPI
}

ClientConfig contains all the API interfaces needed by the state client

type ControlPlane added in v0.1.6 

type ControlPlane struct {
	kkComps.ControlPlane
	NormalizedLabels map[string]string // Non-pointer labels
	GroupMembers     []string
}

ControlPlane represents a normalized control plane for internal use

type ControlPlaneDataPlaneCertificate added in v0.10.0 

type ControlPlaneDataPlaneCertificate struct {
	kkComps.DataPlaneClientCertificate
}

ControlPlaneDataPlaneCertificate represents a data plane certificate for internal use.

type DCRProvider added in v0.8.0 

type DCRProvider struct {
	ID               string
	Name             string
	DisplayName      string
	DisplayNameSet   bool
	ProviderType     string
	Issuer           string
	DCRConfig        map[string]any
	NormalizedLabels map[string]string
}

DCRProvider represents a normalized DCR provider for internal use.

type Dashboard added in v1.0.0 

type Dashboard struct {
	kkComps.DashboardResponse
	NormalizedLabels map[string]string
}

Dashboard represents a Konnect Analytics custom dashboard for internal use.

type ErrorWrapperOptions 

type ErrorWrapperOptions struct {
	ResourceType string
	ResourceName string
	Namespace    string
	StatusCode   int
	UseEnhanced  bool // Whether to use enhanced error with context
}

ErrorWrapperOptions configures how API errors are wrapped

type EventGatewayBackendCluster added in v0.3.8 

type EventGatewayBackendCluster struct {
	kkComps.BackendCluster
	NormalizedLabels map[string]string // Non-pointer labels
}

type EventGatewayClusterPolicyInfo added in v0.8.0 

type EventGatewayClusterPolicyInfo struct {
	kkComps.EventGatewayPolicy
	NormalizedLabels map[string]string
	RawConfig        map[string]any
}

EventGatewayClusterPolicyInfo wraps an Event Gateway Cluster Policy for internal use.

type EventGatewayConsumePolicyInfo added in v0.8.0 

type EventGatewayConsumePolicyInfo struct {
	kkComps.EventGatewayPolicy
	NormalizedLabels map[string]string
	RawConfig        map[string]any
}

EventGatewayConsumePolicyInfo wraps an Event Gateway Consume Policy for internal use. RawConfig contains the full config from the raw API response since the SDK's EventGatewayPolicyConfig struct is empty and doesn't capture actual config data.

type EventGatewayControlPlane added in v0.3.7 

type EventGatewayControlPlane struct {
	kkComps.EventGatewayInfo
	NormalizedLabels map[string]string // Non-pointer labels
}

type EventGatewayDataPlaneCertificate added in v0.6.0 

type EventGatewayDataPlaneCertificate struct {
	kkComps.EventGatewayDataPlaneCertificate
}

EventGatewayDataPlaneCertificate represents a data plane certificate for internal use

type EventGatewayListener added in v0.5.0 

type EventGatewayListener struct {
	kkComps.EventGatewayListener
	NormalizedLabels map[string]string // Non-pointer labels
}

type EventGatewayListenerPolicyInfo added in v0.5.0 

type EventGatewayListenerPolicyInfo struct {
	kkComps.EventGatewayListenerPolicy
	NormalizedLabels map[string]string
	RawConfig        map[string]any
}

EventGatewayListenerPolicyInfo wraps an Event Gateway Listener Policy for internal use. RawConfig contains the full config from the raw API response since the SDK's EventGatewayListenerPolicyConfig struct is empty and doesn't capture actual config data.

type EventGatewaySchemaRegistry added in v0.8.0 

type EventGatewaySchemaRegistry struct {
	kkComps.SchemaRegistry
	NormalizedLabels map[string]string // Non-pointer labels
	RawConfig        map[string]any    // Full config from raw API response
}

EventGatewaySchemaRegistry represents a schema registry for internal use

type EventGatewayStaticKey added in v0.8.0 

type EventGatewayStaticKey struct {
	kkComps.EventGatewayStaticKey
}

EventGatewayStaticKey represents an event gateway static key for internal use.

type EventGatewayTLSTrustBundle added in v0.8.0 

type EventGatewayTLSTrustBundle struct {
	kkComps.TLSTrustBundle
	NormalizedLabels map[string]string
}

EventGatewayTLSTrustBundle represents an event gateway TLS trust bundle for internal use.

type EventGatewayVirtualCluster added in v0.4.0 

type EventGatewayVirtualCluster struct {
	kkComps.VirtualCluster
	NormalizedLabels map[string]string // Non-pointer labels
}

type EventGatewayVirtualClusterProducePolicyInfo added in v0.8.0 

type EventGatewayVirtualClusterProducePolicyInfo struct {
	kkComps.EventGatewayPolicy
	RawConfig map[string]any
}

EventGatewayVirtualClusterProducePolicyInfo wraps a Produce Policy for internal use.

type FilteredPaginatedLister 

type FilteredPaginatedLister[T any] func(
	ctx context.Context, pageSize, pageNumber int64, filter func(T) bool,
) ([]T, *PageMeta, error)

FilteredPaginatedLister wraps a PaginatedLister with additional filtering logic

type GatewayService added in v0.2.0 

type GatewayService struct {
	ID             string
	Name           string
	ControlPlaneID string
	Service        kkComps.ServiceOutput
}

GatewayService represents a gateway service for internal use.

type OrganizationSystemAccount added in v1.0.0 

type OrganizationSystemAccount struct {
	ID   string
	Name string
}

OrganizationSystemAccount represents a Konnect system account selector target.

type OrganizationSystemAccountRole added in v1.0.0 

type OrganizationSystemAccountRole struct {
	ID              string
	RoleName        string
	EntityID        string
	EntityTypeName  string
	EntityRegion    string
	SystemAccountID string
}

OrganizationSystemAccountRole represents an assigned role for an organization system account.

type OrganizationSystemAccountTeamMembership added in v1.0.0 

type OrganizationSystemAccountTeamMembership struct {
	SystemAccountID   string
	SystemAccountName string
	TeamID            string
	TeamName          string
}

OrganizationSystemAccountTeamMembership represents a system account membership in an organization team.

type OrganizationTeam added in v0.4.0 

type OrganizationTeam struct {
	kkComps.Team
	NormalizedLabels map[string]string // Non-pointer labels
}

Team represents a normalized team for internal use I think this should be OrganizationTeam

type OrganizationTeamRole added in v1.0.0 

type OrganizationTeamRole struct {
	ID             string
	RoleName       string
	EntityID       string
	EntityTypeName string
	EntityRegion   string
	TeamID         string
}

OrganizationTeamRole represents an assigned role for an organization team.

type OrganizationUser added in v1.0.0 

type OrganizationUser struct {
	ID    string
	Email string
}

OrganizationUser represents a Konnect organization user.

type OrganizationUserRole added in v1.0.0 

type OrganizationUserRole struct {
	ID             string
	RoleName       string
	EntityID       string
	EntityTypeName string
	EntityRegion   string
	UserID         string
}

OrganizationUserRole represents an assigned role for an organization user.

type OrganizationUserTeamMembership added in v1.0.0 

type OrganizationUserTeamMembership struct {
	UserID    string
	UserEmail string
	TeamID    string
	TeamName  string
}

OrganizationUserTeamMembership represents a user membership in an organization team.

type PageMeta 

type PageMeta struct {
	Total float64
}

PageMeta contains pagination metadata from API responses

type PaginatedLister 

type PaginatedLister[T any] func(ctx context.Context, pageSize, pageNumber int64) ([]T, *PageMeta, error)

PaginatedLister is a function type that can fetch a page of results

type Portal 

type Portal struct {
	kkComps.ListPortalsResponsePortal
	NormalizedLabels map[string]string // Non-pointer labels
}

Portal represents a normalized portal for internal use

type PortalCustomDomain 

type PortalCustomDomain struct {
	ID                       string
	PortalID                 string
	Hostname                 string
	Enabled                  bool
	DomainVerificationMethod string
	VerificationStatus       string
	ValidationErrors         []string
	SkipCACheck              *bool
	UploadedAt               *time.Time
	ExpiresAt                *time.Time
	CnameStatus              string
	CreatedAt                time.Time
	UpdatedAt                time.Time
}

PortalCustomDomain represents portal custom domain (placeholder for missing type)

type PortalCustomization 

type PortalCustomization struct {
}

PortalCustomization represents portal customization (placeholder for missing type)

type PortalEmailTemplate added in v0.3.5 

type PortalEmailTemplate struct {
	ID        string
	Name      string
	Label     string
	Enabled   bool
	Content   *PortalEmailTemplateContent
	Variables []kkComps.EmailTemplateVariableName
}

PortalEmailTemplate represents a customized email template for a portal.

type PortalEmailTemplateContent added in v0.3.5 

type PortalEmailTemplateContent struct {
	Subject     *string
	Title       *string
	Body        *string
	ButtonLabel *string
}

PortalEmailTemplateContent captures the mutable email content fields.

type PortalIPAllowList added in v0.10.0 

type PortalIPAllowList struct {
	ID         string
	PortalID   string
	AllowedIPs []string
}

PortalIPAllowList represents a portal IP allow list entry.

type PortalIdentityProvider added in v0.9.0 

type PortalIdentityProvider struct {
	ID        string
	Type      kkComps.IdentityProviderType
	Enabled   *bool
	LoginPath *string
	Config    *kkComps.IdentityProviderConfig
}

PortalIdentityProvider represents a portal identity provider.

type PortalPage 

type PortalPage struct {
	ID               string
	Slug             string
	Title            string
	Content          string // Will be empty from list, populated from fetch
	Description      string
	Visibility       string
	Status           string
	ParentPageID     string
	NormalizedLabels map[string]string
}

PortalPage represents a portal page for internal use

type PortalSnippet 

type PortalSnippet struct {
	ID               string
	Name             string
	Title            string
	Content          string // Will be empty from list, populated from fetch
	Description      string
	Visibility       string
	Status           string
	NormalizedLabels map[string]string
}

PortalSnippet represents portal snippet

type PortalTeam added in v0.3.3 

type PortalTeam struct {
	ID                 string
	Name               string
	Description        string
	CanOwnApplications *bool
}

PortalTeam represents a portal team (developer team)

type PortalTeamGroupMapping added in v1.0.0 

type PortalTeamGroupMapping struct {
	TeamID string
	Groups []string
}

PortalTeamGroupMapping represents portal team IdP group mappings.

type PortalTeamRole added in v0.3.4 

type PortalTeamRole struct {
	ID             string
	RoleName       string
	EntityID       string
	EntityTypeName string
	EntityRegion   string
	TeamID         string
	PortalID       string
}

PortalTeamRole represents an assigned role for a portal team

type ResponseValidationError 

type ResponseValidationError struct {
	Operation    string
	ExpectedType string
}

ResponseValidationError represents an error when API response is missing expected data

func (*ResponseValidationError) Error 

func (e *ResponseValidationError) Error() string

Source Files

View all Source files

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.