Documentation
¶
Overview ¶
Package oslogin is a generated protocol buffer package.
It is generated from these files:
google/cloud/oslogin/v1beta/oslogin.proto
It has these top-level messages:
LoginProfile DeletePosixAccountRequest DeleteSshPublicKeyRequest GetLoginProfileRequest GetSshPublicKeyRequest ImportSshPublicKeyRequest ImportSshPublicKeyResponse UpdateSshPublicKeyRequest
Index ¶
- func RegisterOsLoginServiceServer(s *grpc.Server, srv OsLoginServiceServer)
- type DeletePosixAccountRequest
- type DeleteSshPublicKeyRequest
- type GetLoginProfileRequest
- type GetSshPublicKeyRequest
- type ImportSshPublicKeyRequest
- func (*ImportSshPublicKeyRequest) Descriptor() ([]byte, []int)
- func (m *ImportSshPublicKeyRequest) GetParent() string
- func (m *ImportSshPublicKeyRequest) GetProjectId() string
- func (m *ImportSshPublicKeyRequest) GetSshPublicKey() *google_cloud_oslogin_common.SshPublicKey
- func (*ImportSshPublicKeyRequest) ProtoMessage()
- func (m *ImportSshPublicKeyRequest) Reset()
- func (m *ImportSshPublicKeyRequest) String() string
- type ImportSshPublicKeyResponse
- type LoginProfile
- func (*LoginProfile) Descriptor() ([]byte, []int)
- func (m *LoginProfile) GetName() string
- func (m *LoginProfile) GetPosixAccounts() []*google_cloud_oslogin_common.PosixAccount
- func (m *LoginProfile) GetSshPublicKeys() map[string]*google_cloud_oslogin_common.SshPublicKey
- func (m *LoginProfile) GetSuspended() bool
- func (*LoginProfile) ProtoMessage()
- func (m *LoginProfile) Reset()
- func (m *LoginProfile) String() string
- type OsLoginServiceClient
- type OsLoginServiceServer
- type UpdateSshPublicKeyRequest
- func (*UpdateSshPublicKeyRequest) Descriptor() ([]byte, []int)
- func (m *UpdateSshPublicKeyRequest) GetName() string
- func (m *UpdateSshPublicKeyRequest) GetSshPublicKey() *google_cloud_oslogin_common.SshPublicKey
- func (m *UpdateSshPublicKeyRequest) GetUpdateMask() *google_protobuf2.FieldMask
- func (*UpdateSshPublicKeyRequest) ProtoMessage()
- func (m *UpdateSshPublicKeyRequest) Reset()
- func (m *UpdateSshPublicKeyRequest) String() string
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RegisterOsLoginServiceServer ¶
func RegisterOsLoginServiceServer(s *grpc.Server, srv OsLoginServiceServer)
Types ¶
type DeletePosixAccountRequest ¶
type DeletePosixAccountRequest struct { // 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" json:"name,omitempty"` }
A request message for deleting a POSIX account entry.
func (*DeletePosixAccountRequest) Descriptor ¶
func (*DeletePosixAccountRequest) Descriptor() ([]byte, []int)
func (*DeletePosixAccountRequest) GetName ¶
func (m *DeletePosixAccountRequest) GetName() string
func (*DeletePosixAccountRequest) ProtoMessage ¶
func (*DeletePosixAccountRequest) ProtoMessage()
func (*DeletePosixAccountRequest) Reset ¶
func (m *DeletePosixAccountRequest) Reset()
func (*DeletePosixAccountRequest) String ¶
func (m *DeletePosixAccountRequest) String() string
type DeleteSshPublicKeyRequest ¶
type DeleteSshPublicKeyRequest struct { // 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" json:"name,omitempty"` }
A request message for deleting an SSH public key.
func (*DeleteSshPublicKeyRequest) Descriptor ¶
func (*DeleteSshPublicKeyRequest) Descriptor() ([]byte, []int)
func (*DeleteSshPublicKeyRequest) GetName ¶
func (m *DeleteSshPublicKeyRequest) GetName() string
func (*DeleteSshPublicKeyRequest) ProtoMessage ¶
func (*DeleteSshPublicKeyRequest) ProtoMessage()
func (*DeleteSshPublicKeyRequest) Reset ¶
func (m *DeleteSshPublicKeyRequest) Reset()
func (*DeleteSshPublicKeyRequest) String ¶
func (m *DeleteSshPublicKeyRequest) String() string
type GetLoginProfileRequest ¶
type GetLoginProfileRequest struct { // The unique ID for the user in format `users/{user}`. Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"` }
A request message for retrieving the login profile information for a user.
func (*GetLoginProfileRequest) Descriptor ¶
func (*GetLoginProfileRequest) Descriptor() ([]byte, []int)
func (*GetLoginProfileRequest) GetName ¶
func (m *GetLoginProfileRequest) GetName() string
func (*GetLoginProfileRequest) ProtoMessage ¶
func (*GetLoginProfileRequest) ProtoMessage()
func (*GetLoginProfileRequest) Reset ¶
func (m *GetLoginProfileRequest) Reset()
func (*GetLoginProfileRequest) String ¶
func (m *GetLoginProfileRequest) String() string
type GetSshPublicKeyRequest ¶
type GetSshPublicKeyRequest struct { // 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" json:"name,omitempty"` }
A request message for retrieving an SSH public key.
func (*GetSshPublicKeyRequest) Descriptor ¶
func (*GetSshPublicKeyRequest) Descriptor() ([]byte, []int)
func (*GetSshPublicKeyRequest) GetName ¶
func (m *GetSshPublicKeyRequest) GetName() string
func (*GetSshPublicKeyRequest) ProtoMessage ¶
func (*GetSshPublicKeyRequest) ProtoMessage()
func (*GetSshPublicKeyRequest) Reset ¶
func (m *GetSshPublicKeyRequest) Reset()
func (*GetSshPublicKeyRequest) String ¶
func (m *GetSshPublicKeyRequest) String() string
type ImportSshPublicKeyRequest ¶
type ImportSshPublicKeyRequest struct { // The unique ID for the user in format `users/{user}`. Parent string `protobuf:"bytes,1,opt,name=parent" json:"parent,omitempty"` // The SSH public key and expiration time. SshPublicKey *google_cloud_oslogin_common.SshPublicKey `protobuf:"bytes,2,opt,name=ssh_public_key,json=sshPublicKey" 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" json:"project_id,omitempty"` }
A request message for importing an SSH public key.
func (*ImportSshPublicKeyRequest) Descriptor ¶
func (*ImportSshPublicKeyRequest) Descriptor() ([]byte, []int)
func (*ImportSshPublicKeyRequest) GetParent ¶
func (m *ImportSshPublicKeyRequest) GetParent() string
func (*ImportSshPublicKeyRequest) GetProjectId ¶
func (m *ImportSshPublicKeyRequest) GetProjectId() string
func (*ImportSshPublicKeyRequest) GetSshPublicKey ¶
func (m *ImportSshPublicKeyRequest) GetSshPublicKey() *google_cloud_oslogin_common.SshPublicKey
func (*ImportSshPublicKeyRequest) ProtoMessage ¶
func (*ImportSshPublicKeyRequest) ProtoMessage()
func (*ImportSshPublicKeyRequest) Reset ¶
func (m *ImportSshPublicKeyRequest) Reset()
func (*ImportSshPublicKeyRequest) String ¶
func (m *ImportSshPublicKeyRequest) String() string
type ImportSshPublicKeyResponse ¶
type ImportSshPublicKeyResponse struct { // The login profile information for the user. LoginProfile *LoginProfile `protobuf:"bytes,1,opt,name=login_profile,json=loginProfile" json:"login_profile,omitempty"` }
A response message for importing an SSH public key.
func (*ImportSshPublicKeyResponse) Descriptor ¶
func (*ImportSshPublicKeyResponse) Descriptor() ([]byte, []int)
func (*ImportSshPublicKeyResponse) GetLoginProfile ¶
func (m *ImportSshPublicKeyResponse) GetLoginProfile() *LoginProfile
func (*ImportSshPublicKeyResponse) ProtoMessage ¶
func (*ImportSshPublicKeyResponse) ProtoMessage()
func (*ImportSshPublicKeyResponse) Reset ¶
func (m *ImportSshPublicKeyResponse) Reset()
func (*ImportSshPublicKeyResponse) String ¶
func (m *ImportSshPublicKeyResponse) String() string
type LoginProfile ¶
type LoginProfile struct { // The primary email address that uniquely identifies the user. Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"` // The list of POSIX accounts associated with the user. PosixAccounts []*google_cloud_oslogin_common.PosixAccount `protobuf:"bytes,2,rep,name=posix_accounts,json=posixAccounts" json:"posix_accounts,omitempty"` // A map from SSH public key fingerprint to the associated key object. SshPublicKeys map[string]*google_cloud_oslogin_common.SshPublicKey `` /* 169-byte string literal not displayed */ // Indicates if the user is suspended. A suspended user cannot log in but // their profile information is retained. Suspended bool `protobuf:"varint,4,opt,name=suspended" json:"suspended,omitempty"` }
The user profile information used for logging in to a virtual machine on Google Compute Engine.
func (*LoginProfile) Descriptor ¶
func (*LoginProfile) Descriptor() ([]byte, []int)
func (*LoginProfile) GetName ¶
func (m *LoginProfile) GetName() string
func (*LoginProfile) GetPosixAccounts ¶
func (m *LoginProfile) GetPosixAccounts() []*google_cloud_oslogin_common.PosixAccount
func (*LoginProfile) GetSshPublicKeys ¶
func (m *LoginProfile) GetSshPublicKeys() map[string]*google_cloud_oslogin_common.SshPublicKey
func (*LoginProfile) GetSuspended ¶
func (m *LoginProfile) GetSuspended() bool
func (*LoginProfile) ProtoMessage ¶
func (*LoginProfile) ProtoMessage()
func (*LoginProfile) Reset ¶
func (m *LoginProfile) Reset()
func (*LoginProfile) String ¶
func (m *LoginProfile) String() string
type OsLoginServiceClient ¶
type OsLoginServiceClient interface { // Deletes a POSIX account. DeletePosixAccount(ctx context.Context, in *DeletePosixAccountRequest, opts ...grpc.CallOption) (*google_protobuf1.Empty, error) // Deletes an SSH public key. DeleteSshPublicKey(ctx context.Context, in *DeleteSshPublicKeyRequest, opts ...grpc.CallOption) (*google_protobuf1.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) (*google_cloud_oslogin_common.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) (*google_cloud_oslogin_common.SshPublicKey, error) }
func NewOsLoginServiceClient ¶
func NewOsLoginServiceClient(cc *grpc.ClientConn) OsLoginServiceClient
type OsLoginServiceServer ¶
type OsLoginServiceServer interface { // Deletes a POSIX account. DeletePosixAccount(context.Context, *DeletePosixAccountRequest) (*google_protobuf1.Empty, error) // Deletes an SSH public key. DeleteSshPublicKey(context.Context, *DeleteSshPublicKeyRequest) (*google_protobuf1.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) (*google_cloud_oslogin_common.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) (*google_cloud_oslogin_common.SshPublicKey, error) }
type UpdateSshPublicKeyRequest ¶
type UpdateSshPublicKeyRequest struct { // 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" json:"name,omitempty"` // The SSH public key and expiration time. SshPublicKey *google_cloud_oslogin_common.SshPublicKey `protobuf:"bytes,2,opt,name=ssh_public_key,json=sshPublicKey" json:"ssh_public_key,omitempty"` // Mask to control which fields get updated. Updates all if not present. UpdateMask *google_protobuf2.FieldMask `protobuf:"bytes,3,opt,name=update_mask,json=updateMask" json:"update_mask,omitempty"` }
A request message for updating an SSH public key.
func (*UpdateSshPublicKeyRequest) Descriptor ¶
func (*UpdateSshPublicKeyRequest) Descriptor() ([]byte, []int)
func (*UpdateSshPublicKeyRequest) GetName ¶
func (m *UpdateSshPublicKeyRequest) GetName() string
func (*UpdateSshPublicKeyRequest) GetSshPublicKey ¶
func (m *UpdateSshPublicKeyRequest) GetSshPublicKey() *google_cloud_oslogin_common.SshPublicKey
func (*UpdateSshPublicKeyRequest) GetUpdateMask ¶
func (m *UpdateSshPublicKeyRequest) GetUpdateMask() *google_protobuf2.FieldMask
func (*UpdateSshPublicKeyRequest) ProtoMessage ¶
func (*UpdateSshPublicKeyRequest) ProtoMessage()
func (*UpdateSshPublicKeyRequest) Reset ¶
func (m *UpdateSshPublicKeyRequest) Reset()
func (*UpdateSshPublicKeyRequest) String ¶
func (m *UpdateSshPublicKeyRequest) String() string
Click to show internal directories.
Click to hide internal directories.