Documentation ¶
Index ¶
- Constants
- Variables
- func RegisterPluginServiceServer(s grpc.ServiceRegistrar, srv PluginServiceServer)
- type CleanupRequest
- type CreatePluginRequest
- func (*CreatePluginRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CreatePluginRequest) GetBootstrapCredentials() *types.PluginBootstrapCredentialsV1
- func (x *CreatePluginRequest) GetCredentialLabels() map[string]string
- func (x *CreatePluginRequest) GetPlugin() *types.PluginV1
- func (x *CreatePluginRequest) GetStaticCredentials() *types.PluginStaticCredentialsV1
- func (x *CreatePluginRequest) GetStaticCredentialsList() []*types.PluginStaticCredentialsV1
- func (*CreatePluginRequest) ProtoMessage()
- func (x *CreatePluginRequest) ProtoReflect() protoreflect.Message
- func (x *CreatePluginRequest) Reset()
- func (x *CreatePluginRequest) String() string
- type DeletePluginRequest
- func (*DeletePluginRequest) Descriptor() ([]byte, []int)deprecated
- func (x *DeletePluginRequest) GetName() string
- func (*DeletePluginRequest) ProtoMessage()
- func (x *DeletePluginRequest) ProtoReflect() protoreflect.Message
- func (x *DeletePluginRequest) Reset()
- func (x *DeletePluginRequest) String() string
- type GetAvailablePluginTypesRequest
- func (*GetAvailablePluginTypesRequest) Descriptor() ([]byte, []int)deprecated
- func (*GetAvailablePluginTypesRequest) ProtoMessage()
- func (x *GetAvailablePluginTypesRequest) ProtoReflect() protoreflect.Message
- func (x *GetAvailablePluginTypesRequest) Reset()
- func (x *GetAvailablePluginTypesRequest) String() string
- type GetAvailablePluginTypesResponse
- func (*GetAvailablePluginTypesResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetAvailablePluginTypesResponse) GetPluginTypes() []*PluginType
- func (*GetAvailablePluginTypesResponse) ProtoMessage()
- func (x *GetAvailablePluginTypesResponse) ProtoReflect() protoreflect.Message
- func (x *GetAvailablePluginTypesResponse) Reset()
- func (x *GetAvailablePluginTypesResponse) String() string
- type GetPluginRequest
- func (*GetPluginRequest) Descriptor() ([]byte, []int)deprecated
- func (x *GetPluginRequest) GetName() string
- func (x *GetPluginRequest) GetWithSecrets() bool
- func (*GetPluginRequest) ProtoMessage()
- func (x *GetPluginRequest) ProtoReflect() protoreflect.Message
- func (x *GetPluginRequest) Reset()
- func (x *GetPluginRequest) String() string
- type ListPluginsRequest
- func (*ListPluginsRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ListPluginsRequest) GetPageSize() int32
- func (x *ListPluginsRequest) GetStartKey() string
- func (x *ListPluginsRequest) GetWithSecrets() bool
- func (*ListPluginsRequest) ProtoMessage()
- func (x *ListPluginsRequest) ProtoReflect() protoreflect.Message
- func (x *ListPluginsRequest) Reset()
- func (x *ListPluginsRequest) String() string
- type ListPluginsResponse
- func (*ListPluginsResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ListPluginsResponse) GetNextKey() string
- func (x *ListPluginsResponse) GetPlugins() []*types.PluginV1
- func (*ListPluginsResponse) ProtoMessage()
- func (x *ListPluginsResponse) ProtoReflect() protoreflect.Message
- func (x *ListPluginsResponse) Reset()
- func (x *ListPluginsResponse) String() string
- type NeedsCleanupRequest
- func (*NeedsCleanupRequest) Descriptor() ([]byte, []int)deprecated
- func (x *NeedsCleanupRequest) GetType() string
- func (*NeedsCleanupRequest) ProtoMessage()
- func (x *NeedsCleanupRequest) ProtoReflect() protoreflect.Message
- func (x *NeedsCleanupRequest) Reset()
- func (x *NeedsCleanupRequest) String() string
- type NeedsCleanupResponse
- func (*NeedsCleanupResponse) Descriptor() ([]byte, []int)deprecated
- func (x *NeedsCleanupResponse) GetNeedsCleanup() bool
- func (x *NeedsCleanupResponse) GetPluginActive() bool
- func (x *NeedsCleanupResponse) GetResourcesToCleanup() []*types.ResourceID
- func (*NeedsCleanupResponse) ProtoMessage()
- func (x *NeedsCleanupResponse) ProtoReflect() protoreflect.Message
- func (x *NeedsCleanupResponse) Reset()
- func (x *NeedsCleanupResponse) String() string
- type PluginServiceClient
- type PluginServiceServer
- type PluginType
- type SearchPluginStaticCredentialsRequest
- func (*SearchPluginStaticCredentialsRequest) Descriptor() ([]byte, []int)deprecated
- func (x *SearchPluginStaticCredentialsRequest) GetLabels() map[string]string
- func (*SearchPluginStaticCredentialsRequest) ProtoMessage()
- func (x *SearchPluginStaticCredentialsRequest) ProtoReflect() protoreflect.Message
- func (x *SearchPluginStaticCredentialsRequest) Reset()
- func (x *SearchPluginStaticCredentialsRequest) String() string
- type SearchPluginStaticCredentialsResponse
- func (*SearchPluginStaticCredentialsResponse) Descriptor() ([]byte, []int)deprecated
- func (x *SearchPluginStaticCredentialsResponse) GetCredentials() []*types.PluginStaticCredentialsV1
- func (*SearchPluginStaticCredentialsResponse) ProtoMessage()
- func (x *SearchPluginStaticCredentialsResponse) ProtoReflect() protoreflect.Message
- func (x *SearchPluginStaticCredentialsResponse) Reset()
- func (x *SearchPluginStaticCredentialsResponse) String() string
- type SetPluginCredentialsRequest
- func (*SetPluginCredentialsRequest) Descriptor() ([]byte, []int)deprecated
- func (x *SetPluginCredentialsRequest) GetCredentials() *types.PluginCredentialsV1
- func (x *SetPluginCredentialsRequest) GetName() string
- func (*SetPluginCredentialsRequest) ProtoMessage()
- func (x *SetPluginCredentialsRequest) ProtoReflect() protoreflect.Message
- func (x *SetPluginCredentialsRequest) Reset()
- func (x *SetPluginCredentialsRequest) String() string
- type SetPluginStatusRequest
- func (*SetPluginStatusRequest) Descriptor() ([]byte, []int)deprecated
- func (x *SetPluginStatusRequest) GetName() string
- func (x *SetPluginStatusRequest) GetStatus() *types.PluginStatusV1
- func (*SetPluginStatusRequest) ProtoMessage()
- func (x *SetPluginStatusRequest) ProtoReflect() protoreflect.Message
- func (x *SetPluginStatusRequest) Reset()
- func (x *SetPluginStatusRequest) String() string
- type UnimplementedPluginServiceServer
- func (UnimplementedPluginServiceServer) Cleanup(context.Context, *CleanupRequest) (*emptypb.Empty, error)
- func (UnimplementedPluginServiceServer) CreatePlugin(context.Context, *CreatePluginRequest) (*emptypb.Empty, error)
- func (UnimplementedPluginServiceServer) DeletePlugin(context.Context, *DeletePluginRequest) (*emptypb.Empty, error)
- func (UnimplementedPluginServiceServer) GetAvailablePluginTypes(context.Context, *GetAvailablePluginTypesRequest) (*GetAvailablePluginTypesResponse, error)
- func (UnimplementedPluginServiceServer) GetPlugin(context.Context, *GetPluginRequest) (*types.PluginV1, error)
- func (UnimplementedPluginServiceServer) ListPlugins(context.Context, *ListPluginsRequest) (*ListPluginsResponse, error)
- func (UnimplementedPluginServiceServer) NeedsCleanup(context.Context, *NeedsCleanupRequest) (*NeedsCleanupResponse, error)
- func (UnimplementedPluginServiceServer) SearchPluginStaticCredentials(context.Context, *SearchPluginStaticCredentialsRequest) (*SearchPluginStaticCredentialsResponse, error)
- func (UnimplementedPluginServiceServer) SetPluginCredentials(context.Context, *SetPluginCredentialsRequest) (*emptypb.Empty, error)
- func (UnimplementedPluginServiceServer) SetPluginStatus(context.Context, *SetPluginStatusRequest) (*emptypb.Empty, error)
- type UnsafePluginServiceServer
Constants ¶
const ( PluginService_CreatePlugin_FullMethodName = "/teleport.plugins.v1.PluginService/CreatePlugin" PluginService_GetPlugin_FullMethodName = "/teleport.plugins.v1.PluginService/GetPlugin" PluginService_DeletePlugin_FullMethodName = "/teleport.plugins.v1.PluginService/DeletePlugin" PluginService_ListPlugins_FullMethodName = "/teleport.plugins.v1.PluginService/ListPlugins" PluginService_SetPluginCredentials_FullMethodName = "/teleport.plugins.v1.PluginService/SetPluginCredentials" PluginService_SetPluginStatus_FullMethodName = "/teleport.plugins.v1.PluginService/SetPluginStatus" PluginService_GetAvailablePluginTypes_FullMethodName = "/teleport.plugins.v1.PluginService/GetAvailablePluginTypes" PluginService_SearchPluginStaticCredentials_FullMethodName = "/teleport.plugins.v1.PluginService/SearchPluginStaticCredentials" PluginService_NeedsCleanup_FullMethodName = "/teleport.plugins.v1.PluginService/NeedsCleanup" PluginService_Cleanup_FullMethodName = "/teleport.plugins.v1.PluginService/Cleanup" )
Variables ¶
var File_teleport_plugins_v1_plugin_service_proto protoreflect.FileDescriptor
var PluginService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "teleport.plugins.v1.PluginService", HandlerType: (*PluginServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "CreatePlugin", Handler: _PluginService_CreatePlugin_Handler, }, { MethodName: "GetPlugin", Handler: _PluginService_GetPlugin_Handler, }, { MethodName: "DeletePlugin", Handler: _PluginService_DeletePlugin_Handler, }, { MethodName: "ListPlugins", Handler: _PluginService_ListPlugins_Handler, }, { MethodName: "SetPluginCredentials", Handler: _PluginService_SetPluginCredentials_Handler, }, { MethodName: "SetPluginStatus", Handler: _PluginService_SetPluginStatus_Handler, }, { MethodName: "GetAvailablePluginTypes", Handler: _PluginService_GetAvailablePluginTypes_Handler, }, { MethodName: "SearchPluginStaticCredentials", Handler: _PluginService_SearchPluginStaticCredentials_Handler, }, { MethodName: "NeedsCleanup", Handler: _PluginService_NeedsCleanup_Handler, }, { MethodName: "Cleanup", Handler: _PluginService_Cleanup_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "teleport/plugins/v1/plugin_service.proto", }
PluginService_ServiceDesc is the grpc.ServiceDesc for PluginService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterPluginServiceServer ¶
func RegisterPluginServiceServer(s grpc.ServiceRegistrar, srv PluginServiceServer)
Types ¶
type CleanupRequest ¶
type CleanupRequest struct { // Type is the plugin type. We only need the string representation of the // plugin type and not the PluginType message, as we don't want the oauth // client ID here. Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"` // contains filtered or unexported fields }
CleanupRequest is the request type for NeedsCleanup.
func (*CleanupRequest) Descriptor
deprecated
func (*CleanupRequest) Descriptor() ([]byte, []int)
Deprecated: Use CleanupRequest.ProtoReflect.Descriptor instead.
func (*CleanupRequest) GetType ¶
func (x *CleanupRequest) GetType() string
func (*CleanupRequest) ProtoMessage ¶
func (*CleanupRequest) ProtoMessage()
func (*CleanupRequest) ProtoReflect ¶
func (x *CleanupRequest) ProtoReflect() protoreflect.Message
func (*CleanupRequest) Reset ¶
func (x *CleanupRequest) Reset()
func (*CleanupRequest) String ¶
func (x *CleanupRequest) String() string
type CreatePluginRequest ¶
type CreatePluginRequest struct { // Plugin is the plugin object without live credentials. Plugin *types.PluginV1 `protobuf:"bytes,1,opt,name=plugin,proto3" json:"plugin,omitempty"` // BootstrapCredentials are the initial credentials // issued by e.g. OAuth2 authorization code flow. // In the scope of processing this request, these are exchanged for // short-lived renewable credentials, which are stored in the Plugin. BootstrapCredentials *types.PluginBootstrapCredentialsV1 `protobuf:"bytes,2,opt,name=bootstrap_credentials,json=bootstrapCredentials,proto3" json:"bootstrap_credentials,omitempty"` // StaticCredentials are an optional static credential to supply to the // plugin. StaticCredentials *types.PluginStaticCredentialsV1 `protobuf:"bytes,3,opt,name=static_credentials,json=staticCredentials,proto3" json:"static_credentials,omitempty"` // StaticCredentials are an optional collection of static credentials // to supply to the plugin. Ignored if `StaticCredentials` is set. StaticCredentialsList []*types.PluginStaticCredentialsV1 `` /* 126-byte string literal not displayed */ // CredentialLabels are a collection of labels used to identify the // credentials secified in the StaticCredentialsList. Ignored if // StaticCredentials is used CredentialLabels map[string]string `` /* 197-byte string literal not displayed */ // contains filtered or unexported fields }
CreatePluginRequest creates a new plugin from the given spec and initial credentials.
func (*CreatePluginRequest) Descriptor
deprecated
func (*CreatePluginRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreatePluginRequest.ProtoReflect.Descriptor instead.
func (*CreatePluginRequest) GetBootstrapCredentials ¶
func (x *CreatePluginRequest) GetBootstrapCredentials() *types.PluginBootstrapCredentialsV1
func (*CreatePluginRequest) GetCredentialLabels ¶
func (x *CreatePluginRequest) GetCredentialLabels() map[string]string
func (*CreatePluginRequest) GetPlugin ¶
func (x *CreatePluginRequest) GetPlugin() *types.PluginV1
func (*CreatePluginRequest) GetStaticCredentials ¶
func (x *CreatePluginRequest) GetStaticCredentials() *types.PluginStaticCredentialsV1
func (*CreatePluginRequest) GetStaticCredentialsList ¶
func (x *CreatePluginRequest) GetStaticCredentialsList() []*types.PluginStaticCredentialsV1
func (*CreatePluginRequest) ProtoMessage ¶
func (*CreatePluginRequest) ProtoMessage()
func (*CreatePluginRequest) ProtoReflect ¶
func (x *CreatePluginRequest) ProtoReflect() protoreflect.Message
func (*CreatePluginRequest) Reset ¶
func (x *CreatePluginRequest) Reset()
func (*CreatePluginRequest) String ¶
func (x *CreatePluginRequest) String() string
type DeletePluginRequest ¶
type DeletePluginRequest struct { // Name is the name of the plugin instance. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // contains filtered or unexported fields }
DeletePluginRequest is a request to delete a plugin instance by name.
func (*DeletePluginRequest) Descriptor
deprecated
func (*DeletePluginRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeletePluginRequest.ProtoReflect.Descriptor instead.
func (*DeletePluginRequest) GetName ¶
func (x *DeletePluginRequest) GetName() string
func (*DeletePluginRequest) ProtoMessage ¶
func (*DeletePluginRequest) ProtoMessage()
func (*DeletePluginRequest) ProtoReflect ¶
func (x *DeletePluginRequest) ProtoReflect() protoreflect.Message
func (*DeletePluginRequest) Reset ¶
func (x *DeletePluginRequest) Reset()
func (*DeletePluginRequest) String ¶
func (x *DeletePluginRequest) String() string
type GetAvailablePluginTypesRequest ¶
type GetAvailablePluginTypesRequest struct {
// contains filtered or unexported fields
}
GetAvailablePluginTypesRequest is the request type for GetAvailablePluginTypes
func (*GetAvailablePluginTypesRequest) Descriptor
deprecated
func (*GetAvailablePluginTypesRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetAvailablePluginTypesRequest.ProtoReflect.Descriptor instead.
func (*GetAvailablePluginTypesRequest) ProtoMessage ¶
func (*GetAvailablePluginTypesRequest) ProtoMessage()
func (*GetAvailablePluginTypesRequest) ProtoReflect ¶
func (x *GetAvailablePluginTypesRequest) ProtoReflect() protoreflect.Message
func (*GetAvailablePluginTypesRequest) Reset ¶
func (x *GetAvailablePluginTypesRequest) Reset()
func (*GetAvailablePluginTypesRequest) String ¶
func (x *GetAvailablePluginTypesRequest) String() string
type GetAvailablePluginTypesResponse ¶
type GetAvailablePluginTypesResponse struct { // PluginTypes is a list of hosted plugins // that the auth service supports. PluginTypes []*PluginType `protobuf:"bytes,1,rep,name=plugin_types,json=pluginTypes,proto3" json:"plugin_types,omitempty"` // contains filtered or unexported fields }
GetAvailablePluginTypesResponse is a response to for GetAvailablePluginTypes
func (*GetAvailablePluginTypesResponse) Descriptor
deprecated
func (*GetAvailablePluginTypesResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetAvailablePluginTypesResponse.ProtoReflect.Descriptor instead.
func (*GetAvailablePluginTypesResponse) GetPluginTypes ¶
func (x *GetAvailablePluginTypesResponse) GetPluginTypes() []*PluginType
func (*GetAvailablePluginTypesResponse) ProtoMessage ¶
func (*GetAvailablePluginTypesResponse) ProtoMessage()
func (*GetAvailablePluginTypesResponse) ProtoReflect ¶
func (x *GetAvailablePluginTypesResponse) ProtoReflect() protoreflect.Message
func (*GetAvailablePluginTypesResponse) Reset ¶
func (x *GetAvailablePluginTypesResponse) Reset()
func (*GetAvailablePluginTypesResponse) String ¶
func (x *GetAvailablePluginTypesResponse) String() string
type GetPluginRequest ¶
type GetPluginRequest struct { // Name is the name of the plugin instance. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // WithSecrets indicates whether plugin secrets (credentials) are requested WithSecrets bool `protobuf:"varint,2,opt,name=with_secrets,json=withSecrets,proto3" json:"with_secrets,omitempty"` // contains filtered or unexported fields }
GetPluginRequest is a request to return a plugin instance by name.
func (*GetPluginRequest) Descriptor
deprecated
func (*GetPluginRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetPluginRequest.ProtoReflect.Descriptor instead.
func (*GetPluginRequest) GetName ¶
func (x *GetPluginRequest) GetName() string
func (*GetPluginRequest) GetWithSecrets ¶
func (x *GetPluginRequest) GetWithSecrets() bool
func (*GetPluginRequest) ProtoMessage ¶
func (*GetPluginRequest) ProtoMessage()
func (*GetPluginRequest) ProtoReflect ¶
func (x *GetPluginRequest) ProtoReflect() protoreflect.Message
func (*GetPluginRequest) Reset ¶
func (x *GetPluginRequest) Reset()
func (*GetPluginRequest) String ¶
func (x *GetPluginRequest) String() string
type ListPluginsRequest ¶
type ListPluginsRequest struct { // PageSize is the maximum number of plugins to return in a single response. PageSize int32 `protobuf:"varint,1,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"` // StartKey is the value of NextKey received in the last ListPluginsResponse. // When making the initial request, this should be left empty. StartKey string `protobuf:"bytes,2,opt,name=start_key,json=startKey,proto3" json:"start_key,omitempty"` // WithSecrets indicates whether plugin secrets (credentials) are requested WithSecrets bool `protobuf:"varint,3,opt,name=with_secrets,json=withSecrets,proto3" json:"with_secrets,omitempty"` // contains filtered or unexported fields }
ListPluginsRequest is a paginated request to list all plugin instances.
func (*ListPluginsRequest) Descriptor
deprecated
func (*ListPluginsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListPluginsRequest.ProtoReflect.Descriptor instead.
func (*ListPluginsRequest) GetPageSize ¶
func (x *ListPluginsRequest) GetPageSize() int32
func (*ListPluginsRequest) GetStartKey ¶
func (x *ListPluginsRequest) GetStartKey() string
func (*ListPluginsRequest) GetWithSecrets ¶
func (x *ListPluginsRequest) GetWithSecrets() bool
func (*ListPluginsRequest) ProtoMessage ¶
func (*ListPluginsRequest) ProtoMessage()
func (*ListPluginsRequest) ProtoReflect ¶
func (x *ListPluginsRequest) ProtoReflect() protoreflect.Message
func (*ListPluginsRequest) Reset ¶
func (x *ListPluginsRequest) Reset()
func (*ListPluginsRequest) String ¶
func (x *ListPluginsRequest) String() string
type ListPluginsResponse ¶
type ListPluginsResponse struct { // Plugins is the list of plugins. Plugins []*types.PluginV1 `protobuf:"bytes,1,rep,name=plugins,proto3" json:"plugins,omitempty"` // NextKey is a token to retrieve the next page of results, or empty // if there are no more results. NextKey string `protobuf:"bytes,2,opt,name=next_key,json=nextKey,proto3" json:"next_key,omitempty"` // contains filtered or unexported fields }
ListPluginsResponse is a paginated response to a ListPluginsRequest.
func (*ListPluginsResponse) Descriptor
deprecated
func (*ListPluginsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListPluginsResponse.ProtoReflect.Descriptor instead.
func (*ListPluginsResponse) GetNextKey ¶
func (x *ListPluginsResponse) GetNextKey() string
func (*ListPluginsResponse) GetPlugins ¶
func (x *ListPluginsResponse) GetPlugins() []*types.PluginV1
func (*ListPluginsResponse) ProtoMessage ¶
func (*ListPluginsResponse) ProtoMessage()
func (*ListPluginsResponse) ProtoReflect ¶
func (x *ListPluginsResponse) ProtoReflect() protoreflect.Message
func (*ListPluginsResponse) Reset ¶
func (x *ListPluginsResponse) Reset()
func (*ListPluginsResponse) String ¶
func (x *ListPluginsResponse) String() string
type NeedsCleanupRequest ¶
type NeedsCleanupRequest struct { // Type is the plugin type. We only need the string representation of the // plugin type and not the PluginType message, as we don't want the oauth // client ID here. Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"` // contains filtered or unexported fields }
NeedsCleanupRequest is the request type for NeedsCleanup.
func (*NeedsCleanupRequest) Descriptor
deprecated
func (*NeedsCleanupRequest) Descriptor() ([]byte, []int)
Deprecated: Use NeedsCleanupRequest.ProtoReflect.Descriptor instead.
func (*NeedsCleanupRequest) GetType ¶
func (x *NeedsCleanupRequest) GetType() string
func (*NeedsCleanupRequest) ProtoMessage ¶
func (*NeedsCleanupRequest) ProtoMessage()
func (*NeedsCleanupRequest) ProtoReflect ¶
func (x *NeedsCleanupRequest) ProtoReflect() protoreflect.Message
func (*NeedsCleanupRequest) Reset ¶
func (x *NeedsCleanupRequest) Reset()
func (*NeedsCleanupRequest) String ¶
func (x *NeedsCleanupRequest) String() string
type NeedsCleanupResponse ¶
type NeedsCleanupResponse struct { // NeedsCleanup will be set to true if the plugin needs cleanup. NeedsCleanup bool `protobuf:"varint,1,opt,name=needs_cleanup,json=needsCleanup,proto3" json:"needs_cleanup,omitempty"` // ResourcesToCleanup are the resources that need to be cleaned up. ResourcesToCleanup []*types.ResourceID `protobuf:"bytes,2,rep,name=resources_to_cleanup,json=resourcesToCleanup,proto3" json:"resources_to_cleanup,omitempty"` // PluginActive returns true if the plugin is currently active. PluginActive bool `protobuf:"varint,3,opt,name=plugin_active,json=pluginActive,proto3" json:"plugin_active,omitempty"` // contains filtered or unexported fields }
NeedsCleanupResponse is the response type for NeedsCleanup.
func (*NeedsCleanupResponse) Descriptor
deprecated
func (*NeedsCleanupResponse) Descriptor() ([]byte, []int)
Deprecated: Use NeedsCleanupResponse.ProtoReflect.Descriptor instead.
func (*NeedsCleanupResponse) GetNeedsCleanup ¶
func (x *NeedsCleanupResponse) GetNeedsCleanup() bool
func (*NeedsCleanupResponse) GetPluginActive ¶
func (x *NeedsCleanupResponse) GetPluginActive() bool
func (*NeedsCleanupResponse) GetResourcesToCleanup ¶
func (x *NeedsCleanupResponse) GetResourcesToCleanup() []*types.ResourceID
func (*NeedsCleanupResponse) ProtoMessage ¶
func (*NeedsCleanupResponse) ProtoMessage()
func (*NeedsCleanupResponse) ProtoReflect ¶
func (x *NeedsCleanupResponse) ProtoReflect() protoreflect.Message
func (*NeedsCleanupResponse) Reset ¶
func (x *NeedsCleanupResponse) Reset()
func (*NeedsCleanupResponse) String ¶
func (x *NeedsCleanupResponse) String() string
type PluginServiceClient ¶
type PluginServiceClient interface { // CreatePlugin creates a new plugin instance. CreatePlugin(ctx context.Context, in *CreatePluginRequest, opts ...grpc.CallOption) (*emptypb.Empty, error) // GetPlugin returns a plugin instance by name. GetPlugin(ctx context.Context, in *GetPluginRequest, opts ...grpc.CallOption) (*types.PluginV1, error) // DeletePlugin removes the specified plugin instance. DeletePlugin(ctx context.Context, in *DeletePluginRequest, opts ...grpc.CallOption) (*emptypb.Empty, error) // ListPlugins returns a paginated view of plugin instances. ListPlugins(ctx context.Context, in *ListPluginsRequest, opts ...grpc.CallOption) (*ListPluginsResponse, error) // SetPluginCredentials sets the credentials for the given plugin. SetPluginCredentials(ctx context.Context, in *SetPluginCredentialsRequest, opts ...grpc.CallOption) (*emptypb.Empty, error) // SetPluginCredentials sets the status for the given plugin. SetPluginStatus(ctx context.Context, in *SetPluginStatusRequest, opts ...grpc.CallOption) (*emptypb.Empty, error) // GetAvailablePluginTypes returns the types of plugins // that the auth server supports onboarding. GetAvailablePluginTypes(ctx context.Context, in *GetAvailablePluginTypesRequest, opts ...grpc.CallOption) (*GetAvailablePluginTypesResponse, error) // SearchPluginStaticCredentials returns static credentials that are searched // for. Only accessible by RoleAdmin and, in the case of Teleport Assist, // RoleProxy. SearchPluginStaticCredentials(ctx context.Context, in *SearchPluginStaticCredentialsRequest, opts ...grpc.CallOption) (*SearchPluginStaticCredentialsResponse, error) // NeedsCleanup will indicate whether a plugin of the given type needs cleanup // before it can be created. NeedsCleanup(ctx context.Context, in *NeedsCleanupRequest, opts ...grpc.CallOption) (*NeedsCleanupResponse, error) // Cleanup will clean up the resources for the given plugin type. Cleanup(ctx context.Context, in *CleanupRequest, opts ...grpc.CallOption) (*emptypb.Empty, error) }
PluginServiceClient is the client API for PluginService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewPluginServiceClient ¶
func NewPluginServiceClient(cc grpc.ClientConnInterface) PluginServiceClient
type PluginServiceServer ¶
type PluginServiceServer interface { // CreatePlugin creates a new plugin instance. CreatePlugin(context.Context, *CreatePluginRequest) (*emptypb.Empty, error) // GetPlugin returns a plugin instance by name. GetPlugin(context.Context, *GetPluginRequest) (*types.PluginV1, error) // DeletePlugin removes the specified plugin instance. DeletePlugin(context.Context, *DeletePluginRequest) (*emptypb.Empty, error) // ListPlugins returns a paginated view of plugin instances. ListPlugins(context.Context, *ListPluginsRequest) (*ListPluginsResponse, error) // SetPluginCredentials sets the credentials for the given plugin. SetPluginCredentials(context.Context, *SetPluginCredentialsRequest) (*emptypb.Empty, error) // SetPluginCredentials sets the status for the given plugin. SetPluginStatus(context.Context, *SetPluginStatusRequest) (*emptypb.Empty, error) // GetAvailablePluginTypes returns the types of plugins // that the auth server supports onboarding. GetAvailablePluginTypes(context.Context, *GetAvailablePluginTypesRequest) (*GetAvailablePluginTypesResponse, error) // SearchPluginStaticCredentials returns static credentials that are searched // for. Only accessible by RoleAdmin and, in the case of Teleport Assist, // RoleProxy. SearchPluginStaticCredentials(context.Context, *SearchPluginStaticCredentialsRequest) (*SearchPluginStaticCredentialsResponse, error) // NeedsCleanup will indicate whether a plugin of the given type needs cleanup // before it can be created. NeedsCleanup(context.Context, *NeedsCleanupRequest) (*NeedsCleanupResponse, error) // Cleanup will clean up the resources for the given plugin type. Cleanup(context.Context, *CleanupRequest) (*emptypb.Empty, error) // contains filtered or unexported methods }
PluginServiceServer is the server API for PluginService service. All implementations must embed UnimplementedPluginServiceServer for forward compatibility
type PluginType ¶
type PluginType struct { // Type is a string corresponding to api.PluginTypeXXX constants Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"` // OAuthClientID contains the client ID of the OAuth application // that is used with this plugin's API provider. // For plugins that are not authenticated via OAuth, // this will be empty. OauthClientId string `protobuf:"bytes,2,opt,name=oauth_client_id,json=oauthClientId,proto3" json:"oauth_client_id,omitempty"` // contains filtered or unexported fields }
PluginType represents a single type of hosted plugin that can be onboarded.
func (*PluginType) Descriptor
deprecated
func (*PluginType) Descriptor() ([]byte, []int)
Deprecated: Use PluginType.ProtoReflect.Descriptor instead.
func (*PluginType) GetOauthClientId ¶
func (x *PluginType) GetOauthClientId() string
func (*PluginType) GetType ¶
func (x *PluginType) GetType() string
func (*PluginType) ProtoMessage ¶
func (*PluginType) ProtoMessage()
func (*PluginType) ProtoReflect ¶
func (x *PluginType) ProtoReflect() protoreflect.Message
func (*PluginType) Reset ¶
func (x *PluginType) Reset()
func (*PluginType) String ¶
func (x *PluginType) String() string
type SearchPluginStaticCredentialsRequest ¶
type SearchPluginStaticCredentialsRequest struct { // Labels are matched against static credentials objects and returned. Labels map[string]string `` /* 153-byte string literal not displayed */ // contains filtered or unexported fields }
SearchPluginStaticCredentialsRequest is the request type for SearchPluginStaticCredentials. The labels here are attached to a plugin and search credential object at creation time. Labels can be provided to the plugin credentials object and then, during plugin creation, a reference to those labels augmented along with a uniquely identifying ID will ensure a unique mapping between credentials and plugins.
func (*SearchPluginStaticCredentialsRequest) Descriptor
deprecated
func (*SearchPluginStaticCredentialsRequest) Descriptor() ([]byte, []int)
Deprecated: Use SearchPluginStaticCredentialsRequest.ProtoReflect.Descriptor instead.
func (*SearchPluginStaticCredentialsRequest) GetLabels ¶
func (x *SearchPluginStaticCredentialsRequest) GetLabels() map[string]string
func (*SearchPluginStaticCredentialsRequest) ProtoMessage ¶
func (*SearchPluginStaticCredentialsRequest) ProtoMessage()
func (*SearchPluginStaticCredentialsRequest) ProtoReflect ¶
func (x *SearchPluginStaticCredentialsRequest) ProtoReflect() protoreflect.Message
func (*SearchPluginStaticCredentialsRequest) Reset ¶
func (x *SearchPluginStaticCredentialsRequest) Reset()
func (*SearchPluginStaticCredentialsRequest) String ¶
func (x *SearchPluginStaticCredentialsRequest) String() string
type SearchPluginStaticCredentialsResponse ¶
type SearchPluginStaticCredentialsResponse struct { // Credentials are the list of credentials matching the requested labels. Credentials []*types.PluginStaticCredentialsV1 `protobuf:"bytes,1,rep,name=credentials,proto3" json:"credentials,omitempty"` // contains filtered or unexported fields }
SearchPluginStaticCredentialsResponse is the response type for SearchPluginStaticCredentials
func (*SearchPluginStaticCredentialsResponse) Descriptor
deprecated
func (*SearchPluginStaticCredentialsResponse) Descriptor() ([]byte, []int)
Deprecated: Use SearchPluginStaticCredentialsResponse.ProtoReflect.Descriptor instead.
func (*SearchPluginStaticCredentialsResponse) GetCredentials ¶
func (x *SearchPluginStaticCredentialsResponse) GetCredentials() []*types.PluginStaticCredentialsV1
func (*SearchPluginStaticCredentialsResponse) ProtoMessage ¶
func (*SearchPluginStaticCredentialsResponse) ProtoMessage()
func (*SearchPluginStaticCredentialsResponse) ProtoReflect ¶
func (x *SearchPluginStaticCredentialsResponse) ProtoReflect() protoreflect.Message
func (*SearchPluginStaticCredentialsResponse) Reset ¶
func (x *SearchPluginStaticCredentialsResponse) Reset()
func (*SearchPluginStaticCredentialsResponse) String ¶
func (x *SearchPluginStaticCredentialsResponse) String() string
type SetPluginCredentialsRequest ¶
type SetPluginCredentialsRequest struct { // Name is the name of the plugin instance. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Credentials are the credentials obtained after exchanging the initial // credentials, and after successive credential renewals. Credentials *types.PluginCredentialsV1 `protobuf:"bytes,2,opt,name=credentials,proto3" json:"credentials,omitempty"` // contains filtered or unexported fields }
SetPluginCredentialsRequest is a request to set credentials for an existing plugin
func (*SetPluginCredentialsRequest) Descriptor
deprecated
func (*SetPluginCredentialsRequest) Descriptor() ([]byte, []int)
Deprecated: Use SetPluginCredentialsRequest.ProtoReflect.Descriptor instead.
func (*SetPluginCredentialsRequest) GetCredentials ¶
func (x *SetPluginCredentialsRequest) GetCredentials() *types.PluginCredentialsV1
func (*SetPluginCredentialsRequest) GetName ¶
func (x *SetPluginCredentialsRequest) GetName() string
func (*SetPluginCredentialsRequest) ProtoMessage ¶
func (*SetPluginCredentialsRequest) ProtoMessage()
func (*SetPluginCredentialsRequest) ProtoReflect ¶
func (x *SetPluginCredentialsRequest) ProtoReflect() protoreflect.Message
func (*SetPluginCredentialsRequest) Reset ¶
func (x *SetPluginCredentialsRequest) Reset()
func (*SetPluginCredentialsRequest) String ¶
func (x *SetPluginCredentialsRequest) String() string
type SetPluginStatusRequest ¶
type SetPluginStatusRequest struct { // Name is the name of the plugin instance. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Status is the plugin status. Status *types.PluginStatusV1 `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"` // contains filtered or unexported fields }
SetPluginStatusRequest is a request to set the status for an existing plugin
func (*SetPluginStatusRequest) Descriptor
deprecated
func (*SetPluginStatusRequest) Descriptor() ([]byte, []int)
Deprecated: Use SetPluginStatusRequest.ProtoReflect.Descriptor instead.
func (*SetPluginStatusRequest) GetName ¶
func (x *SetPluginStatusRequest) GetName() string
func (*SetPluginStatusRequest) GetStatus ¶
func (x *SetPluginStatusRequest) GetStatus() *types.PluginStatusV1
func (*SetPluginStatusRequest) ProtoMessage ¶
func (*SetPluginStatusRequest) ProtoMessage()
func (*SetPluginStatusRequest) ProtoReflect ¶
func (x *SetPluginStatusRequest) ProtoReflect() protoreflect.Message
func (*SetPluginStatusRequest) Reset ¶
func (x *SetPluginStatusRequest) Reset()
func (*SetPluginStatusRequest) String ¶
func (x *SetPluginStatusRequest) String() string
type UnimplementedPluginServiceServer ¶
type UnimplementedPluginServiceServer struct { }
UnimplementedPluginServiceServer must be embedded to have forward compatible implementations.
func (UnimplementedPluginServiceServer) Cleanup ¶
func (UnimplementedPluginServiceServer) Cleanup(context.Context, *CleanupRequest) (*emptypb.Empty, error)
func (UnimplementedPluginServiceServer) CreatePlugin ¶
func (UnimplementedPluginServiceServer) CreatePlugin(context.Context, *CreatePluginRequest) (*emptypb.Empty, error)
func (UnimplementedPluginServiceServer) DeletePlugin ¶
func (UnimplementedPluginServiceServer) DeletePlugin(context.Context, *DeletePluginRequest) (*emptypb.Empty, error)
func (UnimplementedPluginServiceServer) GetAvailablePluginTypes ¶
func (UnimplementedPluginServiceServer) GetAvailablePluginTypes(context.Context, *GetAvailablePluginTypesRequest) (*GetAvailablePluginTypesResponse, error)
func (UnimplementedPluginServiceServer) GetPlugin ¶
func (UnimplementedPluginServiceServer) GetPlugin(context.Context, *GetPluginRequest) (*types.PluginV1, error)
func (UnimplementedPluginServiceServer) ListPlugins ¶
func (UnimplementedPluginServiceServer) ListPlugins(context.Context, *ListPluginsRequest) (*ListPluginsResponse, error)
func (UnimplementedPluginServiceServer) NeedsCleanup ¶
func (UnimplementedPluginServiceServer) NeedsCleanup(context.Context, *NeedsCleanupRequest) (*NeedsCleanupResponse, error)
func (UnimplementedPluginServiceServer) SearchPluginStaticCredentials ¶
func (UnimplementedPluginServiceServer) SearchPluginStaticCredentials(context.Context, *SearchPluginStaticCredentialsRequest) (*SearchPluginStaticCredentialsResponse, error)
func (UnimplementedPluginServiceServer) SetPluginCredentials ¶
func (UnimplementedPluginServiceServer) SetPluginCredentials(context.Context, *SetPluginCredentialsRequest) (*emptypb.Empty, error)
func (UnimplementedPluginServiceServer) SetPluginStatus ¶
func (UnimplementedPluginServiceServer) SetPluginStatus(context.Context, *SetPluginStatusRequest) (*emptypb.Empty, error)
type UnsafePluginServiceServer ¶
type UnsafePluginServiceServer interface {
// contains filtered or unexported methods
}
UnsafePluginServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to PluginServiceServer will result in compilation errors.