Package cloud.google.com/go/oslogin/apiv1/osloginpb (v1.14.7)

Version latest

• 1.14.7 (latest)
• 1.14.6
• 1.13.8
• 1.12.2
• 1.10.1
• 1.9.1
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.1.0

Note: To get more information about this package, such as access to older versions, view this package on pkg.go.dev.

Constants

OsLoginService_CreateSshPublicKey_FullMethodName, OsLoginService_DeletePosixAccount_FullMethodName, OsLoginService_DeleteSshPublicKey_FullMethodName, OsLoginService_GetLoginProfile_FullMethodName, OsLoginService_GetSshPublicKey_FullMethodName, OsLoginService_ImportSshPublicKey_FullMethodName, OsLoginService_UpdateSshPublicKey_FullMethodName

const (
	OsLoginService_CreateSshPublicKey_FullMethodName = "/google.cloud.oslogin.v1.OsLoginService/CreateSshPublicKey"
	OsLoginService_DeletePosixAccount_FullMethodName = "/google.cloud.oslogin.v1.OsLoginService/DeletePosixAccount"
	OsLoginService_DeleteSshPublicKey_FullMethodName = "/google.cloud.oslogin.v1.OsLoginService/DeleteSshPublicKey"
	OsLoginService_GetLoginProfile_FullMethodName    = "/google.cloud.oslogin.v1.OsLoginService/GetLoginProfile"
	OsLoginService_GetSshPublicKey_FullMethodName    = "/google.cloud.oslogin.v1.OsLoginService/GetSshPublicKey"
	OsLoginService_ImportSshPublicKey_FullMethodName = "/google.cloud.oslogin.v1.OsLoginService/ImportSshPublicKey"
	OsLoginService_UpdateSshPublicKey_FullMethodName = "/google.cloud.oslogin.v1.OsLoginService/UpdateSshPublicKey"
)

Variables

File_google_cloud_oslogin_v1_oslogin_proto

var File_google_cloud_oslogin_v1_oslogin_proto protoreflect.FileDescriptor

OsLoginService_ServiceDesc

var OsLoginService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.oslogin.v1.OsLoginService",
	HandlerType: (*OsLoginServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CreateSshPublicKey",
			Handler:    _OsLoginService_CreateSshPublicKey_Handler,
		},
		{
			MethodName: "DeletePosixAccount",
			Handler:    _OsLoginService_DeletePosixAccount_Handler,
		},
		{
			MethodName: "DeleteSshPublicKey",
			Handler:    _OsLoginService_DeleteSshPublicKey_Handler,
		},
		{
			MethodName: "GetLoginProfile",
			Handler:    _OsLoginService_GetLoginProfile_Handler,
		},
		{
			MethodName: "GetSshPublicKey",
			Handler:    _OsLoginService_GetSshPublicKey_Handler,
		},
		{
			MethodName: "ImportSshPublicKey",
			Handler:    _OsLoginService_ImportSshPublicKey_Handler,
		},
		{
			MethodName: "UpdateSshPublicKey",
			Handler:    _OsLoginService_UpdateSshPublicKey_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/oslogin/v1/oslogin.proto",
}

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

Functions

func RegisterOsLoginServiceServer

func RegisterOsLoginServiceServer(s grpc.ServiceRegistrar, srv OsLoginServiceServer)

CreateSshPublicKeyRequest

type CreateSshPublicKeyRequest struct {

	// Required. The unique ID for the user in format `users/{user}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The SSH public key and expiration time.
	SshPublicKey *commonpb.SshPublicKey `protobuf:"bytes,2,opt,name=ssh_public_key,json=sshPublicKey,proto3" json:"ssh_public_key,omitempty"`
	// contains filtered or unexported fields
}

A request message for creating an SSH public key.

func (*CreateSshPublicKeyRequest) Descriptor

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

Deprecated: Use CreateSshPublicKeyRequest.ProtoReflect.Descriptor instead.

func (*CreateSshPublicKeyRequest) GetParent

func (x *CreateSshPublicKeyRequest) GetParent() string

func (*CreateSshPublicKeyRequest) GetSshPublicKey

func (x *CreateSshPublicKeyRequest) GetSshPublicKey() *commonpb.SshPublicKey

func (*CreateSshPublicKeyRequest) ProtoMessage

func (*CreateSshPublicKeyRequest) ProtoMessage()

func (*CreateSshPublicKeyRequest) ProtoReflect

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

func (*CreateSshPublicKeyRequest) Reset

func (x *CreateSshPublicKeyRequest) Reset()

func (*CreateSshPublicKeyRequest) String

func (x *CreateSshPublicKeyRequest) String() string

DeletePosixAccountRequest

type DeletePosixAccountRequest struct {

	// Required. A reference to the POSIX account to update. POSIX accounts are
	// identified by the project ID they are associated with. A reference to the
	// POSIX account is in format `users/{user}/projects/{project}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

A request message for deleting a POSIX account entry.

func (*DeletePosixAccountRequest) Descriptor

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

Deprecated: Use DeletePosixAccountRequest.ProtoReflect.Descriptor instead.

func (*DeletePosixAccountRequest) GetName

func (x *DeletePosixAccountRequest) GetName() string

func (*DeletePosixAccountRequest) ProtoMessage

func (*DeletePosixAccountRequest) ProtoMessage()

func (*DeletePosixAccountRequest) ProtoReflect

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

func (*DeletePosixAccountRequest) Reset

func (x *DeletePosixAccountRequest) Reset()

func (*DeletePosixAccountRequest) String

func (x *DeletePosixAccountRequest) String() string

DeleteSshPublicKeyRequest

type DeleteSshPublicKeyRequest struct {

	// Required. The fingerprint of the public key to update. Public keys are
	// identified by their SHA-256 fingerprint. The fingerprint of the public key
	// is in format `users/{user}/sshPublicKeys/{fingerprint}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

A request message for deleting an SSH public key.

func (*DeleteSshPublicKeyRequest) Descriptor

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

Deprecated: Use DeleteSshPublicKeyRequest.ProtoReflect.Descriptor instead.

func (*DeleteSshPublicKeyRequest) GetName

func (x *DeleteSshPublicKeyRequest) GetName() string

func (*DeleteSshPublicKeyRequest) ProtoMessage

func (*DeleteSshPublicKeyRequest) ProtoMessage()

func (*DeleteSshPublicKeyRequest) ProtoReflect

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

func (*DeleteSshPublicKeyRequest) Reset

func (x *DeleteSshPublicKeyRequest) Reset()

func (*DeleteSshPublicKeyRequest) String

func (x *DeleteSshPublicKeyRequest) String() string

GetLoginProfileRequest

type GetLoginProfileRequest struct {

	// Required. The unique ID for the user in format `users/{user}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The project ID of the Google Cloud Platform project.
	ProjectId string `protobuf:"bytes,2,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// A system ID for filtering the results of the request.
	SystemId string `protobuf:"bytes,3,opt,name=system_id,json=systemId,proto3" json:"system_id,omitempty"`
	// contains filtered or unexported fields
}

A request message for retrieving the login profile information for a user.

func (*GetLoginProfileRequest) Descriptor

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

Deprecated: Use GetLoginProfileRequest.ProtoReflect.Descriptor instead.

func (*GetLoginProfileRequest) GetName

func (x *GetLoginProfileRequest) GetName() string

func (*GetLoginProfileRequest) GetProjectId

func (x *GetLoginProfileRequest) GetProjectId() string

func (*GetLoginProfileRequest) GetSystemId

func (x *GetLoginProfileRequest) GetSystemId() string

func (*GetLoginProfileRequest) ProtoMessage

func (*GetLoginProfileRequest) ProtoMessage()

func (*GetLoginProfileRequest) ProtoReflect

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

func (*GetLoginProfileRequest) Reset

func (x *GetLoginProfileRequest) Reset()

func (*GetLoginProfileRequest) String

func (x *GetLoginProfileRequest) String() string

GetSshPublicKeyRequest

type GetSshPublicKeyRequest struct {

	// Required. The fingerprint of the public key to retrieve. Public keys are
	// identified by their SHA-256 fingerprint. The fingerprint of the public key
	// is in format `users/{user}/sshPublicKeys/{fingerprint}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

A request message for retrieving an SSH public key.

func (*GetSshPublicKeyRequest) Descriptor

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

Deprecated: Use GetSshPublicKeyRequest.ProtoReflect.Descriptor instead.

func (*GetSshPublicKeyRequest) GetName

func (x *GetSshPublicKeyRequest) GetName() string

func (*GetSshPublicKeyRequest) ProtoMessage

func (*GetSshPublicKeyRequest) ProtoMessage()

func (*GetSshPublicKeyRequest) ProtoReflect

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

func (*GetSshPublicKeyRequest) Reset

func (x *GetSshPublicKeyRequest) Reset()

func (*GetSshPublicKeyRequest) String

func (x *GetSshPublicKeyRequest) String() string

ImportSshPublicKeyRequest

type ImportSshPublicKeyRequest struct {

	// Required. The unique ID for the user in format `users/{user}`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. The SSH public key and expiration time.
	SshPublicKey *commonpb.SshPublicKey `protobuf:"bytes,2,opt,name=ssh_public_key,json=sshPublicKey,proto3" json:"ssh_public_key,omitempty"`
	// The project ID of the Google Cloud Platform project.
	ProjectId string `protobuf:"bytes,3,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// Optional. The regions to which to assert that the key was written.
	// If unspecified, defaults to all regions.
	// Regions are listed at https://cloud.google.com/about/locations#region.
	Regions []string `protobuf:"bytes,5,rep,name=regions,proto3" json:"regions,omitempty"`
	// contains filtered or unexported fields
}

A request message for importing an SSH public key.

func (*ImportSshPublicKeyRequest) Descriptor

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

Deprecated: Use ImportSshPublicKeyRequest.ProtoReflect.Descriptor instead.

func (*ImportSshPublicKeyRequest) GetParent

func (x *ImportSshPublicKeyRequest) GetParent() string

func (*ImportSshPublicKeyRequest) GetProjectId

func (x *ImportSshPublicKeyRequest) GetProjectId() string

func (*ImportSshPublicKeyRequest) GetRegions

func (x *ImportSshPublicKeyRequest) GetRegions() []string

func (*ImportSshPublicKeyRequest) GetSshPublicKey

func (x *ImportSshPublicKeyRequest) GetSshPublicKey() *commonpb.SshPublicKey

func (*ImportSshPublicKeyRequest) ProtoMessage

func (*ImportSshPublicKeyRequest) ProtoMessage()

func (*ImportSshPublicKeyRequest) ProtoReflect

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

func (*ImportSshPublicKeyRequest) Reset

func (x *ImportSshPublicKeyRequest) Reset()

func (*ImportSshPublicKeyRequest) String

func (x *ImportSshPublicKeyRequest) String() string

ImportSshPublicKeyResponse

type ImportSshPublicKeyResponse struct {

	// The login profile information for the user.
	LoginProfile *LoginProfile `protobuf:"bytes,1,opt,name=login_profile,json=loginProfile,proto3" json:"login_profile,omitempty"`
	// Detailed information about import results.
	Details string `protobuf:"bytes,2,opt,name=details,proto3" json:"details,omitempty"`
	// contains filtered or unexported fields
}

A response message for importing an SSH public key.

func (*ImportSshPublicKeyResponse) Descriptor

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

Deprecated: Use ImportSshPublicKeyResponse.ProtoReflect.Descriptor instead.

func (*ImportSshPublicKeyResponse) GetDetails

func (x *ImportSshPublicKeyResponse) GetDetails() string

func (*ImportSshPublicKeyResponse) GetLoginProfile

func (x *ImportSshPublicKeyResponse) GetLoginProfile() *LoginProfile

func (*ImportSshPublicKeyResponse) ProtoMessage

func (*ImportSshPublicKeyResponse) ProtoMessage()

func (*ImportSshPublicKeyResponse) ProtoReflect

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

func (*ImportSshPublicKeyResponse) Reset

func (x *ImportSshPublicKeyResponse) Reset()

func (*ImportSshPublicKeyResponse) String

func (x *ImportSshPublicKeyResponse) String() string

LoginProfile

type LoginProfile struct {

	// Required. A unique user ID.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The list of POSIX accounts associated with the user.
	PosixAccounts []*commonpb.PosixAccount `protobuf:"bytes,2,rep,name=posix_accounts,json=posixAccounts,proto3" json:"posix_accounts,omitempty"`
	// A map from SSH public key fingerprint to the associated key object.
	SshPublicKeys map[string]*commonpb.SshPublicKey `protobuf:"bytes,3,rep,name=ssh_public_keys,json=sshPublicKeys,proto3" json:"ssh_public_keys,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
	// contains filtered or unexported fields
}

The user profile information used for logging in to a virtual machine on Google Compute Engine.

func (*LoginProfile) Descriptor

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

Deprecated: Use LoginProfile.ProtoReflect.Descriptor instead.

func (*LoginProfile) GetName

func (x *LoginProfile) GetName() string

func (*LoginProfile) GetPosixAccounts

func (x *LoginProfile) GetPosixAccounts() []*commonpb.PosixAccount

func (*LoginProfile) GetSshPublicKeys

func (x *LoginProfile) GetSshPublicKeys() map[string]*commonpb.SshPublicKey

func (*LoginProfile) ProtoMessage

func (*LoginProfile) ProtoMessage()

func (*LoginProfile) ProtoReflect

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

func (*LoginProfile) Reset

func (x *LoginProfile) Reset()

func (*LoginProfile) String

func (x *LoginProfile) String() string

OsLoginServiceClient

type OsLoginServiceClient interface {
	// Create an SSH public key
	CreateSshPublicKey(ctx context.Context, in *CreateSshPublicKeyRequest, opts ...grpc.CallOption) (*commonpb.SshPublicKey, error)
	// Deletes a POSIX account.
	DeletePosixAccount(ctx context.Context, in *DeletePosixAccountRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Deletes an SSH public key.
	DeleteSshPublicKey(ctx context.Context, in *DeleteSshPublicKeyRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Retrieves the profile information used for logging in to a virtual machine
	// on Google Compute Engine.
	GetLoginProfile(ctx context.Context, in *GetLoginProfileRequest, opts ...grpc.CallOption) (*LoginProfile, error)
	// Retrieves an SSH public key.
	GetSshPublicKey(ctx context.Context, in *GetSshPublicKeyRequest, opts ...grpc.CallOption) (*commonpb.SshPublicKey, error)
	// Adds an SSH public key and returns the profile information. Default POSIX
	// account information is set when no username and UID exist as part of the
	// login profile.
	ImportSshPublicKey(ctx context.Context, in *ImportSshPublicKeyRequest, opts ...grpc.CallOption) (*ImportSshPublicKeyResponse, error)
	// Updates an SSH public key and returns the profile information. This method
	// supports patch semantics.
	UpdateSshPublicKey(ctx context.Context, in *UpdateSshPublicKeyRequest, opts ...grpc.CallOption) (*commonpb.SshPublicKey, error)
}

OsLoginServiceClient is the client API for OsLoginService 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 NewOsLoginServiceClient

func NewOsLoginServiceClient(cc grpc.ClientConnInterface) OsLoginServiceClient

OsLoginServiceServer

type OsLoginServiceServer interface {
	// Create an SSH public key
	CreateSshPublicKey(context.Context, *CreateSshPublicKeyRequest) (*commonpb.SshPublicKey, error)
	// Deletes a POSIX account.
	DeletePosixAccount(context.Context, *DeletePosixAccountRequest) (*emptypb.Empty, error)
	// Deletes an SSH public key.
	DeleteSshPublicKey(context.Context, *DeleteSshPublicKeyRequest) (*emptypb.Empty, error)
	// Retrieves the profile information used for logging in to a virtual machine
	// on Google Compute Engine.
	GetLoginProfile(context.Context, *GetLoginProfileRequest) (*LoginProfile, error)
	// Retrieves an SSH public key.
	GetSshPublicKey(context.Context, *GetSshPublicKeyRequest) (*commonpb.SshPublicKey, error)
	// Adds an SSH public key and returns the profile information. Default POSIX
	// account information is set when no username and UID exist as part of the
	// login profile.
	ImportSshPublicKey(context.Context, *ImportSshPublicKeyRequest) (*ImportSshPublicKeyResponse, error)
	// Updates an SSH public key and returns the profile information. This method
	// supports patch semantics.
	UpdateSshPublicKey(context.Context, *UpdateSshPublicKeyRequest) (*commonpb.SshPublicKey, error)
}

OsLoginServiceServer is the server API for OsLoginService service. All implementations should embed UnimplementedOsLoginServiceServer for forward compatibility

UnimplementedOsLoginServiceServer

type UnimplementedOsLoginServiceServer struct {
}

UnimplementedOsLoginServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedOsLoginServiceServer) CreateSshPublicKey

func (UnimplementedOsLoginServiceServer) CreateSshPublicKey(context.Context, *CreateSshPublicKeyRequest) (*commonpb.SshPublicKey, error)

func (UnimplementedOsLoginServiceServer) DeletePosixAccount

func (UnimplementedOsLoginServiceServer) DeletePosixAccount(context.Context, *DeletePosixAccountRequest) (*emptypb.Empty, error)

func (UnimplementedOsLoginServiceServer) DeleteSshPublicKey

func (UnimplementedOsLoginServiceServer) DeleteSshPublicKey(context.Context, *DeleteSshPublicKeyRequest) (*emptypb.Empty, error)

func (UnimplementedOsLoginServiceServer) GetLoginProfile

func (UnimplementedOsLoginServiceServer) GetLoginProfile(context.Context, *GetLoginProfileRequest) (*LoginProfile, error)

func (UnimplementedOsLoginServiceServer) GetSshPublicKey

func (UnimplementedOsLoginServiceServer) GetSshPublicKey(context.Context, *GetSshPublicKeyRequest) (*commonpb.SshPublicKey, error)

func (UnimplementedOsLoginServiceServer) ImportSshPublicKey

func (UnimplementedOsLoginServiceServer) ImportSshPublicKey(context.Context, *ImportSshPublicKeyRequest) (*ImportSshPublicKeyResponse, error)

func (UnimplementedOsLoginServiceServer) UpdateSshPublicKey

func (UnimplementedOsLoginServiceServer) UpdateSshPublicKey(context.Context, *UpdateSshPublicKeyRequest) (*commonpb.SshPublicKey, error)

UnsafeOsLoginServiceServer

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

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

UpdateSshPublicKeyRequest

type UpdateSshPublicKeyRequest struct {

	// Required. The fingerprint of the public key to update. Public keys are
	// identified by their SHA-256 fingerprint. The fingerprint of the public key
	// is in format `users/{user}/sshPublicKeys/{fingerprint}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The SSH public key and expiration time.
	SshPublicKey *commonpb.SshPublicKey `protobuf:"bytes,2,opt,name=ssh_public_key,json=sshPublicKey,proto3" json:"ssh_public_key,omitempty"`
	// Mask to control which fields get updated. Updates all if not present.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,3,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

A request message for updating an SSH public key.

func (*UpdateSshPublicKeyRequest) Descriptor

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

Deprecated: Use UpdateSshPublicKeyRequest.ProtoReflect.Descriptor instead.

func (*UpdateSshPublicKeyRequest) GetName

func (x *UpdateSshPublicKeyRequest) GetName() string

func (*UpdateSshPublicKeyRequest) GetSshPublicKey

func (x *UpdateSshPublicKeyRequest) GetSshPublicKey() *commonpb.SshPublicKey

func (*UpdateSshPublicKeyRequest) GetUpdateMask

func (x *UpdateSshPublicKeyRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateSshPublicKeyRequest) ProtoMessage

func (*UpdateSshPublicKeyRequest) ProtoMessage()

func (*UpdateSshPublicKeyRequest) ProtoReflect

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

func (*UpdateSshPublicKeyRequest) Reset

func (x *UpdateSshPublicKeyRequest) Reset()

func (*UpdateSshPublicKeyRequest) String

func (x *UpdateSshPublicKeyRequest) String() string