userprovisioningv2

package
v0.0.0-...-3b5622f Latest Latest
Warning

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

 Go to latest Published: Apr 28, 2025 License: Apache-2.0 Imports: 12 Imported by: 2

Documentation

Index

Constants

View Source 
const (
	StaticHostUsersService_GetStaticHostUser_FullMethodName    = "/teleport.userprovisioning.v2.StaticHostUsersService/GetStaticHostUser"
	StaticHostUsersService_ListStaticHostUsers_FullMethodName  = "/teleport.userprovisioning.v2.StaticHostUsersService/ListStaticHostUsers"
	StaticHostUsersService_CreateStaticHostUser_FullMethodName = "/teleport.userprovisioning.v2.StaticHostUsersService/CreateStaticHostUser"
	StaticHostUsersService_UpdateStaticHostUser_FullMethodName = "/teleport.userprovisioning.v2.StaticHostUsersService/UpdateStaticHostUser"
	StaticHostUsersService_UpsertStaticHostUser_FullMethodName = "/teleport.userprovisioning.v2.StaticHostUsersService/UpsertStaticHostUser"
	StaticHostUsersService_DeleteStaticHostUser_FullMethodName = "/teleport.userprovisioning.v2.StaticHostUsersService/DeleteStaticHostUser"
)

Variables

View Source 
var File_teleport_userprovisioning_v2_statichostuser_proto protoreflect.FileDescriptor
View Source 
var File_teleport_userprovisioning_v2_statichostuser_service_proto protoreflect.FileDescriptor
View Source 
var StaticHostUsersService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "teleport.userprovisioning.v2.StaticHostUsersService",
	HandlerType: (*StaticHostUsersServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetStaticHostUser",
			Handler:    _StaticHostUsersService_GetStaticHostUser_Handler,
		},
		{
			MethodName: "ListStaticHostUsers",
			Handler:    _StaticHostUsersService_ListStaticHostUsers_Handler,
		},
		{
			MethodName: "CreateStaticHostUser",
			Handler:    _StaticHostUsersService_CreateStaticHostUser_Handler,
		},
		{
			MethodName: "UpdateStaticHostUser",
			Handler:    _StaticHostUsersService_UpdateStaticHostUser_Handler,
		},
		{
			MethodName: "UpsertStaticHostUser",
			Handler:    _StaticHostUsersService_UpsertStaticHostUser_Handler,
		},
		{
			MethodName: "DeleteStaticHostUser",
			Handler:    _StaticHostUsersService_DeleteStaticHostUser_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "teleport/userprovisioning/v2/statichostuser_service.proto",
}

StaticHostUsersService_ServiceDesc is the grpc.ServiceDesc for StaticHostUsersService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterStaticHostUsersServiceServer 

func RegisterStaticHostUsersServiceServer(s grpc.ServiceRegistrar, srv StaticHostUsersServiceServer)

Types

type CreateStaticHostUserRequest 

type CreateStaticHostUserRequest struct {

	// The static host user resource to create.
	User *StaticHostUser `protobuf:"bytes,1,opt,name=user,proto3" json:"user,omitempty"`
	// contains filtered or unexported fields
}

Request for CreateStaticHostUser.

func (*CreateStaticHostUserRequest) Descriptor deprecated 

func (*CreateStaticHostUserRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateStaticHostUserRequest.ProtoReflect.Descriptor instead.

func (*CreateStaticHostUserRequest) GetUser 

func (x *CreateStaticHostUserRequest) GetUser() *StaticHostUser

func (*CreateStaticHostUserRequest) ProtoMessage 

func (*CreateStaticHostUserRequest) ProtoMessage()

func (*CreateStaticHostUserRequest) ProtoReflect 

func (x *CreateStaticHostUserRequest) ProtoReflect() protoreflect.Message

func (*CreateStaticHostUserRequest) Reset 

func (x *CreateStaticHostUserRequest) Reset()

func (*CreateStaticHostUserRequest) String 

func (x *CreateStaticHostUserRequest) String() string

type DeleteStaticHostUserRequest 

type DeleteStaticHostUserRequest struct {

	// Name of the user resource to remove.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for DeleteStaticHostUser.

func (*DeleteStaticHostUserRequest) Descriptor deprecated 

func (*DeleteStaticHostUserRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteStaticHostUserRequest.ProtoReflect.Descriptor instead.

func (*DeleteStaticHostUserRequest) GetName 

func (x *DeleteStaticHostUserRequest) GetName() string

func (*DeleteStaticHostUserRequest) ProtoMessage 

func (*DeleteStaticHostUserRequest) ProtoMessage()

func (*DeleteStaticHostUserRequest) ProtoReflect 

func (x *DeleteStaticHostUserRequest) ProtoReflect() protoreflect.Message

func (*DeleteStaticHostUserRequest) Reset 

func (x *DeleteStaticHostUserRequest) Reset()

func (*DeleteStaticHostUserRequest) String 

func (x *DeleteStaticHostUserRequest) String() string

type GetStaticHostUserRequest 

type GetStaticHostUserRequest struct {

	// Name of the user to retrieve, this take priority over current_user.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for GetStaticHostUser.

func (*GetStaticHostUserRequest) Descriptor deprecated 

func (*GetStaticHostUserRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetStaticHostUserRequest.ProtoReflect.Descriptor instead.

func (*GetStaticHostUserRequest) GetName 

func (x *GetStaticHostUserRequest) GetName() string

func (*GetStaticHostUserRequest) ProtoMessage 

func (*GetStaticHostUserRequest) ProtoMessage()

func (*GetStaticHostUserRequest) ProtoReflect 

func (x *GetStaticHostUserRequest) ProtoReflect() protoreflect.Message

func (*GetStaticHostUserRequest) Reset 

func (x *GetStaticHostUserRequest) Reset()

func (*GetStaticHostUserRequest) String 

func (x *GetStaticHostUserRequest) String() string

type ListStaticHostUsersRequest 

type ListStaticHostUsersRequest struct {

	// The maximum number of items to return.
	// The server may impose a different page size at its discretion.
	PageSize int32 `protobuf:"varint,1,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The next_page_token value returned from a previous List request, if any.
	PageToken string `protobuf:"bytes,2,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request for ListStaticHostUsers.

Follows the pagination semantics of https://cloud.google.com/apis/design/standard_methods#list.

func (*ListStaticHostUsersRequest) Descriptor deprecated 

func (*ListStaticHostUsersRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListStaticHostUsersRequest.ProtoReflect.Descriptor instead.

func (*ListStaticHostUsersRequest) GetPageSize 

func (x *ListStaticHostUsersRequest) GetPageSize() int32

func (*ListStaticHostUsersRequest) GetPageToken 

func (x *ListStaticHostUsersRequest) GetPageToken() string

func (*ListStaticHostUsersRequest) ProtoMessage 

func (*ListStaticHostUsersRequest) ProtoMessage()

func (*ListStaticHostUsersRequest) ProtoReflect 

func (x *ListStaticHostUsersRequest) ProtoReflect() protoreflect.Message

func (*ListStaticHostUsersRequest) Reset 

func (x *ListStaticHostUsersRequest) Reset()

func (*ListStaticHostUsersRequest) String 

func (x *ListStaticHostUsersRequest) String() string

type ListStaticHostUsersResponse 

type ListStaticHostUsersResponse struct {

	// Static host users that matched the search.
	Users []*StaticHostUser `protobuf:"bytes,1,rep,name=users,proto3" json:"users,omitempty"`
	// Token to retrieve the next page of results, or empty if there are no
	// more results in the list.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response for ListStaticHostUsers.

func (*ListStaticHostUsersResponse) Descriptor deprecated 

func (*ListStaticHostUsersResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListStaticHostUsersResponse.ProtoReflect.Descriptor instead.

func (*ListStaticHostUsersResponse) GetNextPageToken 

func (x *ListStaticHostUsersResponse) GetNextPageToken() string

func (*ListStaticHostUsersResponse) GetUsers 

func (x *ListStaticHostUsersResponse) GetUsers() []*StaticHostUser

func (*ListStaticHostUsersResponse) ProtoMessage 

func (*ListStaticHostUsersResponse) ProtoMessage()

func (*ListStaticHostUsersResponse) ProtoReflect 

func (x *ListStaticHostUsersResponse) ProtoReflect() protoreflect.Message

func (*ListStaticHostUsersResponse) Reset 

func (x *ListStaticHostUsersResponse) Reset()

func (*ListStaticHostUsersResponse) String 

func (x *ListStaticHostUsersResponse) String() string

type Matcher 

type Matcher struct {

	// node_labels is a map of node labels that will create a user from this
	// resource.
	NodeLabels []*v11.Label `protobuf:"bytes,1,rep,name=node_labels,json=nodeLabels,proto3" json:"node_labels,omitempty"`
	// node_labels_expression is a predicate expression to create a user from
	// this resource.
	NodeLabelsExpression string `protobuf:"bytes,2,opt,name=node_labels_expression,json=nodeLabelsExpression,proto3" json:"node_labels_expression,omitempty"`
	// groups is a list of additional groups to add the user to.
	Groups []string `protobuf:"bytes,3,rep,name=groups,proto3" json:"groups,omitempty"`
	// sudoers is a list of sudoer entries to add.
	Sudoers []string `protobuf:"bytes,4,rep,name=sudoers,proto3" json:"sudoers,omitempty"`
	// uid is the new user's uid.
	Uid int64 `protobuf:"varint,5,opt,name=uid,proto3" json:"uid,omitempty"`
	// gid is the new user's gid.
	Gid int64 `protobuf:"varint,6,opt,name=gid,proto3" json:"gid,omitempty"`
	// default_shell is the new user's default shell
	DefaultShell string `protobuf:"bytes,7,opt,name=default_shell,json=defaultShell,proto3" json:"default_shell,omitempty"`
	// take_ownership_if_user_exists will take ownership of existing, unmanaged users
	TakeOwnershipIfUserExists bool `` /* 143-byte string literal not displayed */
	// contains filtered or unexported fields
}

Matcher is a matcher for nodes to add the user to.

func (*Matcher) Descriptor deprecated 

func (*Matcher) Descriptor() ([]byte, []int)

Deprecated: Use Matcher.ProtoReflect.Descriptor instead.

func (*Matcher) GetDefaultShell 

func (x *Matcher) GetDefaultShell() string

func (*Matcher) GetGid 

func (x *Matcher) GetGid() int64

func (*Matcher) GetGroups 

func (x *Matcher) GetGroups() []string

func (*Matcher) GetNodeLabels 

func (x *Matcher) GetNodeLabels() []*v11.Label

func (*Matcher) GetNodeLabelsExpression 

func (x *Matcher) GetNodeLabelsExpression() string

func (*Matcher) GetSudoers 

func (x *Matcher) GetSudoers() []string

func (*Matcher) GetTakeOwnershipIfUserExists 

func (x *Matcher) GetTakeOwnershipIfUserExists() bool

func (*Matcher) GetUid 

func (x *Matcher) GetUid() int64

func (*Matcher) ProtoMessage 

func (*Matcher) ProtoMessage()

func (*Matcher) ProtoReflect 

func (x *Matcher) ProtoReflect() protoreflect.Message

func (*Matcher) Reset 

func (x *Matcher) Reset()

func (*Matcher) String 

func (x *Matcher) String() string

type StaticHostUser 

type StaticHostUser struct {

	// kind is a resource kind.
	Kind string `protobuf:"bytes,1,opt,name=kind,proto3" json:"kind,omitempty"`
	// sub_kind is an optional resource sub kind, used in some resources.
	SubKind string `protobuf:"bytes,2,opt,name=sub_kind,json=subKind,proto3" json:"sub_kind,omitempty"`
	// version is the resource version. It must be specified.
	// Supported values are: `v2`.
	Version string `protobuf:"bytes,3,opt,name=version,proto3" json:"version,omitempty"`
	// metadata is resource metadata.
	Metadata *v1.Metadata `protobuf:"bytes,4,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// spec is the static host user spec.
	Spec *StaticHostUserSpec `protobuf:"bytes,5,opt,name=spec,proto3" json:"spec,omitempty"`
	// contains filtered or unexported fields
}

StaticHostUser is a resource that represents host users that should be created on matching nodes.

func (*StaticHostUser) Descriptor deprecated 

func (*StaticHostUser) Descriptor() ([]byte, []int)

Deprecated: Use StaticHostUser.ProtoReflect.Descriptor instead.

func (*StaticHostUser) GetKind 

func (x *StaticHostUser) GetKind() string

func (*StaticHostUser) GetMetadata 

func (x *StaticHostUser) GetMetadata() *v1.Metadata

func (*StaticHostUser) GetSpec 

func (x *StaticHostUser) GetSpec() *StaticHostUserSpec

func (*StaticHostUser) GetSubKind 

func (x *StaticHostUser) GetSubKind() string

func (*StaticHostUser) GetVersion 

func (x *StaticHostUser) GetVersion() string

func (*StaticHostUser) ProtoMessage 

func (*StaticHostUser) ProtoMessage()

func (*StaticHostUser) ProtoReflect 

func (x *StaticHostUser) ProtoReflect() protoreflect.Message

func (*StaticHostUser) Reset 

func (x *StaticHostUser) Reset()

func (*StaticHostUser) String 

func (x *StaticHostUser) String() string

type StaticHostUserSpec 

type StaticHostUserSpec struct {
	Matchers []*Matcher `protobuf:"bytes,1,rep,name=matchers,proto3" json:"matchers,omitempty"`
	// contains filtered or unexported fields
}

StaticHostUserSpec is the static host user spec.

func (*StaticHostUserSpec) Descriptor deprecated 

func (*StaticHostUserSpec) Descriptor() ([]byte, []int)

Deprecated: Use StaticHostUserSpec.ProtoReflect.Descriptor instead.

func (*StaticHostUserSpec) GetMatchers 

func (x *StaticHostUserSpec) GetMatchers() []*Matcher

func (*StaticHostUserSpec) ProtoMessage 

func (*StaticHostUserSpec) ProtoMessage()

func (*StaticHostUserSpec) ProtoReflect 

func (x *StaticHostUserSpec) ProtoReflect() protoreflect.Message

func (*StaticHostUserSpec) Reset 

func (x *StaticHostUserSpec) Reset()

func (*StaticHostUserSpec) String 

func (x *StaticHostUserSpec) String() string

type StaticHostUsersServiceClient 

type StaticHostUsersServiceClient interface {
	// GetStaticHostUser retrieves a static host user resource by name.
	GetStaticHostUser(ctx context.Context, in *GetStaticHostUserRequest, opts ...grpc.CallOption) (*StaticHostUser, error)
	// ListStaticHostUsers gets all existing static host users.
	ListStaticHostUsers(ctx context.Context, in *ListStaticHostUsersRequest, opts ...grpc.CallOption) (*ListStaticHostUsersResponse, error)
	// CreateStaticHostUser creates a static host user if one does not already exist.
	CreateStaticHostUser(ctx context.Context, in *CreateStaticHostUserRequest, opts ...grpc.CallOption) (*StaticHostUser, error)
	// UpdateStaticHostUser updates an existing static host user.
	UpdateStaticHostUser(ctx context.Context, in *UpdateStaticHostUserRequest, opts ...grpc.CallOption) (*StaticHostUser, error)
	// UpsertStaticHostUser creates a new static host user or forcefully updates an existing static host user.
	UpsertStaticHostUser(ctx context.Context, in *UpsertStaticHostUserRequest, opts ...grpc.CallOption) (*StaticHostUser, error)
	// DeleteStaticHostUser removes an existing static host user resource by name.
	DeleteStaticHostUser(ctx context.Context, in *DeleteStaticHostUserRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
}

StaticHostUsersServiceClient is the client API for StaticHostUsersService 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.

StaticHostUsersService provides methods to manage static host users.

func NewStaticHostUsersServiceClient 

func NewStaticHostUsersServiceClient(cc grpc.ClientConnInterface) StaticHostUsersServiceClient

type StaticHostUsersServiceServer 

type StaticHostUsersServiceServer interface {
	// GetStaticHostUser retrieves a static host user resource by name.
	GetStaticHostUser(context.Context, *GetStaticHostUserRequest) (*StaticHostUser, error)
	// ListStaticHostUsers gets all existing static host users.
	ListStaticHostUsers(context.Context, *ListStaticHostUsersRequest) (*ListStaticHostUsersResponse, error)
	// CreateStaticHostUser creates a static host user if one does not already exist.
	CreateStaticHostUser(context.Context, *CreateStaticHostUserRequest) (*StaticHostUser, error)
	// UpdateStaticHostUser updates an existing static host user.
	UpdateStaticHostUser(context.Context, *UpdateStaticHostUserRequest) (*StaticHostUser, error)
	// UpsertStaticHostUser creates a new static host user or forcefully updates an existing static host user.
	UpsertStaticHostUser(context.Context, *UpsertStaticHostUserRequest) (*StaticHostUser, error)
	// DeleteStaticHostUser removes an existing static host user resource by name.
	DeleteStaticHostUser(context.Context, *DeleteStaticHostUserRequest) (*emptypb.Empty, error)
	// contains filtered or unexported methods
}

StaticHostUsersServiceServer is the server API for StaticHostUsersService service. All implementations must embed UnimplementedStaticHostUsersServiceServer for forward compatibility.

StaticHostUsersService provides methods to manage static host users.

type UnimplementedStaticHostUsersServiceServer 

type UnimplementedStaticHostUsersServiceServer struct{}

UnimplementedStaticHostUsersServiceServer must be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedStaticHostUsersServiceServer) CreateStaticHostUser 

func (UnimplementedStaticHostUsersServiceServer) CreateStaticHostUser(context.Context, *CreateStaticHostUserRequest) (*StaticHostUser, error)

func (UnimplementedStaticHostUsersServiceServer) DeleteStaticHostUser 

func (UnimplementedStaticHostUsersServiceServer) DeleteStaticHostUser(context.Context, *DeleteStaticHostUserRequest) (*emptypb.Empty, error)

func (UnimplementedStaticHostUsersServiceServer) GetStaticHostUser 

func (UnimplementedStaticHostUsersServiceServer) GetStaticHostUser(context.Context, *GetStaticHostUserRequest) (*StaticHostUser, error)

func (UnimplementedStaticHostUsersServiceServer) ListStaticHostUsers 

func (UnimplementedStaticHostUsersServiceServer) ListStaticHostUsers(context.Context, *ListStaticHostUsersRequest) (*ListStaticHostUsersResponse, error)

func (UnimplementedStaticHostUsersServiceServer) UpdateStaticHostUser 

func (UnimplementedStaticHostUsersServiceServer) UpdateStaticHostUser(context.Context, *UpdateStaticHostUserRequest) (*StaticHostUser, error)

func (UnimplementedStaticHostUsersServiceServer) UpsertStaticHostUser 

func (UnimplementedStaticHostUsersServiceServer) UpsertStaticHostUser(context.Context, *UpsertStaticHostUserRequest) (*StaticHostUser, error)

type UnsafeStaticHostUsersServiceServer 

type UnsafeStaticHostUsersServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeStaticHostUsersServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to StaticHostUsersServiceServer will result in compilation errors.

type UpdateStaticHostUserRequest 

type UpdateStaticHostUserRequest struct {

	// The static host user resource to update.
	User *StaticHostUser `protobuf:"bytes,2,opt,name=user,proto3" json:"user,omitempty"`
	// contains filtered or unexported fields
}

Request for UpdateStaticHostUser.

func (*UpdateStaticHostUserRequest) Descriptor deprecated 

func (*UpdateStaticHostUserRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateStaticHostUserRequest.ProtoReflect.Descriptor instead.

func (*UpdateStaticHostUserRequest) GetUser 

func (x *UpdateStaticHostUserRequest) GetUser() *StaticHostUser

func (*UpdateStaticHostUserRequest) ProtoMessage 

func (*UpdateStaticHostUserRequest) ProtoMessage()

func (*UpdateStaticHostUserRequest) ProtoReflect 

func (x *UpdateStaticHostUserRequest) ProtoReflect() protoreflect.Message

func (*UpdateStaticHostUserRequest) Reset 

func (x *UpdateStaticHostUserRequest) Reset()

func (*UpdateStaticHostUserRequest) String 

func (x *UpdateStaticHostUserRequest) String() string

type UpsertStaticHostUserRequest 

type UpsertStaticHostUserRequest struct {

	// The static host user resource to upsert.
	User *StaticHostUser `protobuf:"bytes,2,opt,name=user,proto3" json:"user,omitempty"`
	// contains filtered or unexported fields
}

Request for UpsertStaticHostUser.

func (*UpsertStaticHostUserRequest) Descriptor deprecated 

func (*UpsertStaticHostUserRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpsertStaticHostUserRequest.ProtoReflect.Descriptor instead.

func (*UpsertStaticHostUserRequest) GetUser 

func (x *UpsertStaticHostUserRequest) GetUser() *StaticHostUser

func (*UpsertStaticHostUserRequest) ProtoMessage 

func (*UpsertStaticHostUserRequest) ProtoMessage()

func (*UpsertStaticHostUserRequest) ProtoReflect 

func (x *UpsertStaticHostUserRequest) ProtoReflect() protoreflect.Message

func (*UpsertStaticHostUserRequest) Reset 

func (x *UpsertStaticHostUserRequest) Reset()

func (*UpsertStaticHostUserRequest) String 

func (x *UpsertStaticHostUserRequest) String() 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.