Package cloud.google.com/go/oslogin/apiv1beta/osloginpb (v1.12.2)

Variables

LoginProfileView_name, LoginProfileView_value

  var 
  
 ( 
  
 LoginProfileView_name 
  
 = 
  
 map 
 [ 
  int32 
 
 ] 
  string 
 
 { 
  
 0 
 : 
  
 "LOGIN_PROFILE_VIEW_UNSPECIFIED" 
 , 
  
 1 
 : 
  
 "BASIC" 
 , 
  
 2 
 : 
  
 "SECURITY_KEY" 
 , 
  
 } 
  
 LoginProfileView_value 
  
 = 
  
 map 
 [ 
  string 
 
 ] 
  int32 
 
 { 
  
 "LOGIN_PROFILE_VIEW_UNSPECIFIED" 
 : 
  
 0 
 , 
  
 "BASIC" 
 : 
  
 1 
 , 
  
 "SECURITY_KEY" 
 : 
  
 2 
 , 
  
 } 
 ) 
 

Enum value maps for LoginProfileView.

File_google_cloud_oslogin_v1beta_oslogin_proto

  var 
  
 File_google_cloud_oslogin_v1beta_oslogin_proto 
  
  protoreflect 
 
 . 
  FileDescriptor 
 
 

Functions

func RegisterOsLoginServiceServer

  func 
  
 RegisterOsLoginServiceServer 
 ( 
 s 
  
 * 
  grpc 
 
 . 
  Server 
 
 , 
  
 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 (*CreateSshPublicKeyRequest) Reset

  func 
  
 ( 
 x 
  
 * 
  CreateSshPublicKeyRequest 
 
 ) 
  
 Reset 
 () 
 

func (*CreateSshPublicKeyRequest) 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 (*DeletePosixAccountRequest) ProtoMessage

  func 
  
 ( 
 * 
  DeletePosixAccountRequest 
 
 ) 
  
 ProtoMessage 
 () 
 

func (*DeletePosixAccountRequest) ProtoReflect

func (*DeletePosixAccountRequest) Reset

  func 
  
 ( 
 x 
  
 * 
  DeletePosixAccountRequest 
 
 ) 
  
 Reset 
 () 
 

func (*DeletePosixAccountRequest) 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 (*DeleteSshPublicKeyRequest) ProtoMessage

  func 
  
 ( 
 * 
  DeleteSshPublicKeyRequest 
 
 ) 
  
 ProtoMessage 
 () 
 

func (*DeleteSshPublicKeyRequest) ProtoReflect

func (*DeleteSshPublicKeyRequest) Reset

  func 
  
 ( 
 x 
  
 * 
  DeleteSshPublicKeyRequest 
 
 ) 
  
 Reset 
 () 
 

func (*DeleteSshPublicKeyRequest) 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"` 
  
 // The view configures whether to retrieve security keys information. 
  
 View 
  
  LoginProfileView 
 
  
 `protobuf:"varint,4,opt,name=view,proto3,enum=google.cloud.oslogin.v1beta.LoginProfileView" json:"view,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) GetView

func (*GetLoginProfileRequest) ProtoMessage

  func 
  
 ( 
 * 
  GetLoginProfileRequest 
 
 ) 
  
 ProtoMessage 
 () 
 

func (*GetLoginProfileRequest) ProtoReflect

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 (*GetSshPublicKeyRequest) Reset

  func 
  
 ( 
 x 
  
 * 
  GetSshPublicKeyRequest 
 
 ) 
  
 Reset 
 () 
 

func (*GetSshPublicKeyRequest) String

  func 
  
 ( 
 x 
  
 * 
  GetSshPublicKeyRequest 
 
 ) 
  
 String 
 () 
  
  string 
 
 

ImportSshPublicKeyRequest

  type 
  
 ImportSshPublicKeyRequest 
  
 struct 
  
 { 
  
 // 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"` 
  
 // 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"` 
  
 // The view configures whether to retrieve security keys information. 
  
 View 
  
  LoginProfileView 
 
  
 `protobuf:"varint,4,opt,name=view,proto3,enum=google.cloud.oslogin.v1beta.LoginProfileView" json:"view,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) GetSshPublicKey

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

func (*ImportSshPublicKeyRequest) GetView

func (*ImportSshPublicKeyRequest) ProtoMessage

  func 
  
 ( 
 * 
  ImportSshPublicKeyRequest 
 
 ) 
  
 ProtoMessage 
 () 
 

func (*ImportSshPublicKeyRequest) ProtoReflect

func (*ImportSshPublicKeyRequest) Reset

  func 
  
 ( 
 x 
  
 * 
  ImportSshPublicKeyRequest 
 
 ) 
  
 Reset 
 () 
 

func (*ImportSshPublicKeyRequest) 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 (*ImportSshPublicKeyResponse) Reset

  func 
  
 ( 
 x 
  
 * 
  ImportSshPublicKeyResponse 
 
 ) 
  
 Reset 
 () 
 

func (*ImportSshPublicKeyResponse) String

LoginProfile

  type 
  
 LoginProfile 
  
 struct 
  
 { 
  
 Name 
  
  string 
 
  
 `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` 
  
 PosixAccounts 
  
 [] 
 * 
  commonpb 
 
 . 
  PosixAccount 
 
  
 `protobuf:"bytes,2,rep,name=posix_accounts,json=posixAccounts,proto3" json:"posix_accounts,omitempty"` 
  
 SshPublicKeys 
  
 map 
 [ 
  string 
 
 ] 
 * 
  commonpb 
 
 . 
  SshPublicKey 
 
  
 "" 
  
 /* 190 byte string literal not displayed */ 
  
 SecurityKeys 
  
 [] 
 * 
  SecurityKey 
 
  
 `protobuf:"bytes,5,rep,name=security_keys,json=securityKeys,proto3" json:"security_keys,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 
 
 ) 
 

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) GetSecurityKeys

  func 
  
 ( 
 x 
  
 * 
  LoginProfile 
 
 ) 
  
 GetSecurityKeys 
 () 
  
 [] 
 * 
  SecurityKey 
 
 

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 
 
 

LoginProfileView

  type 
  
 LoginProfileView 
  
  int32 
 
 

The login profile view limits the user content retrieved.

  const 
  
 ( 
  
 // The default login profile view. The API defaults to the BASIC view. 
  
 LoginProfileView_LOGIN_PROFILE_VIEW_UNSPECIFIED 
  
  LoginProfileView 
 
  
 = 
  
 0 
  
 // Includes POSIX and SSH key information. 
  
 LoginProfileView_BASIC 
  
  LoginProfileView 
 
  
 = 
  
 1 
  
 // Include security key information for the user. 
  
 LoginProfileView_SECURITY_KEY 
  
  LoginProfileView 
 
  
 = 
  
 2 
 ) 
 

func (LoginProfileView) Descriptor

func (LoginProfileView) Enum

func (LoginProfileView) EnumDescriptor

  func 
  
 ( 
  LoginProfileView 
 
 ) 
  
 EnumDescriptor 
 () 
  
 ([] 
  byte 
 
 , 
  
 [] 
  int 
 
 ) 
 

Deprecated: Use LoginProfileView.Descriptor instead.

func (LoginProfileView) Number

func (LoginProfileView) String

  func 
  
 ( 
 x 
  
  LoginProfileView 
 
 ) 
  
 String 
 () 
  
  string 
 
 

func (LoginProfileView) Type

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 
 
 ) 
  
 // Signs an SSH public key for a user to authenticate to an instance. 
  
 SignSshPublicKey 
 ( 
 ctx 
  
  context 
 
 . 
  Context 
 
 , 
  
 in 
  
 * 
  SignSshPublicKeyRequest 
 
 , 
  
 opts 
  
 ... 
  grpc 
 
 . 
  CallOption 
 
 ) 
  
 ( 
 * 
  SignSshPublicKeyResponse 
 
 , 
  
  error 
 
 ) 
 } 
 

OsLoginServiceClient is the client API for OsLoginService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#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 
 
 ) 
  
 // Signs an SSH public key for a user to authenticate to an instance. 
  
 SignSshPublicKey 
 ( 
  context 
 
 . 
  Context 
 
 , 
  
 * 
  SignSshPublicKeyRequest 
 
 ) 
  
 ( 
 * 
  SignSshPublicKeyResponse 
 
 , 
  
  error 
 
 ) 
 } 
 

OsLoginServiceServer is the server API for OsLoginService service.

SecurityKey

  type 
  
 SecurityKey 
  
 struct 
  
 { 
  
 // Public key text in SSH format, defined by 
  
 // [RFC4253]("https://www.ietf.org/rfc/rfc4253.txt") section 6.6. 
  
 PublicKey 
  
  string 
 
  
 `protobuf:"bytes,1,opt,name=public_key,json=publicKey,proto3" json:"public_key,omitempty"` 
  
 // Hardware-backed private key text in SSH format. 
  
 PrivateKey 
  
  string 
 
  
 `protobuf:"bytes,2,opt,name=private_key,json=privateKey,proto3" json:"private_key,omitempty"` 
  
 // The FIDO protocol type used to register this credential. 
  
 // 
  
 // Types that are assignable to ProtocolType: 
  
 //	*SecurityKey_UniversalTwoFactor 
  
 //	*SecurityKey_WebAuthn 
  
 ProtocolType 
  
 isSecurityKey_ProtocolType 
  
 `protobuf_oneof:"protocol_type"` 
  
 // The security key nickname explicitly set by the user. 
  
 DeviceNickname 
  
 * 
  string 
 
  
 `protobuf:"bytes,5,opt,name=device_nickname,json=deviceNickname,proto3,oneof" json:"device_nickname,omitempty"` 
  
 // contains filtered or unexported fields 
 } 
 

The credential information for a Google registered security key.

func (*SecurityKey) Descriptor

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

Deprecated: Use SecurityKey.ProtoReflect.Descriptor instead.

func (*SecurityKey) GetDeviceNickname

  func 
  
 ( 
 x 
  
 * 
  SecurityKey 
 
 ) 
  
 GetDeviceNickname 
 () 
  
  string 
 
 

func (*SecurityKey) GetPrivateKey

  func 
  
 ( 
 x 
  
 * 
  SecurityKey 
 
 ) 
  
 GetPrivateKey 
 () 
  
  string 
 
 

func (*SecurityKey) GetProtocolType

  func 
  
 ( 
 m 
  
 * 
  SecurityKey 
 
 ) 
  
 GetProtocolType 
 () 
  
 isSecurityKey_ProtocolType 
 

func (*SecurityKey) GetPublicKey

  func 
  
 ( 
 x 
  
 * 
  SecurityKey 
 
 ) 
  
 GetPublicKey 
 () 
  
  string 
 
 

func (*SecurityKey) GetUniversalTwoFactor

  func 
  
 ( 
 x 
  
 * 
  SecurityKey 
 
 ) 
  
 GetUniversalTwoFactor 
 () 
  
 * 
  UniversalTwoFactor 
 
 

func (*SecurityKey) GetWebAuthn

  func 
  
 ( 
 x 
  
 * 
  SecurityKey 
 
 ) 
  
 GetWebAuthn 
 () 
  
 * 
  WebAuthn 
 
 

func (*SecurityKey) ProtoMessage

  func 
  
 ( 
 * 
  SecurityKey 
 
 ) 
  
 ProtoMessage 
 () 
 

func (*SecurityKey) ProtoReflect

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

func (*SecurityKey) Reset

  func 
  
 ( 
 x 
  
 * 
  SecurityKey 
 
 ) 
  
 Reset 
 () 
 

func (*SecurityKey) String

  func 
  
 ( 
 x 
  
 * 
  SecurityKey 
 
 ) 
  
 String 
 () 
  
  string 
 
 

SecurityKey_UniversalTwoFactor

  type 
  
 SecurityKey_UniversalTwoFactor 
  
 struct 
  
 { 
  
 // The U2F protocol type. 
  
 UniversalTwoFactor 
  
 * 
  UniversalTwoFactor 
 
  
 `protobuf:"bytes,3,opt,name=universal_two_factor,json=universalTwoFactor,proto3,oneof"` 
 } 
 

SecurityKey_WebAuthn

  type 
  
 SecurityKey_WebAuthn 
  
 struct 
  
 { 
  
 // The Web Authentication protocol type. 
  
 WebAuthn 
  
 * 
  WebAuthn 
 
  
 `protobuf:"bytes,4,opt,name=web_authn,json=webAuthn,proto3,oneof"` 
 } 
 

SignSshPublicKeyRequest

  type 
  
 SignSshPublicKeyRequest 
  
 struct 
  
 { 
  
 // The SSH public key to sign. 
  
 SshPublicKey 
  
  string 
 
  
 `protobuf:"bytes,1,opt,name=ssh_public_key,json=sshPublicKey,proto3" json:"ssh_public_key,omitempty"` 
  
 // The parent project and zone for the signing request. This is needed to 
  
 // properly ensure per-organization ISS processing and potentially to provide 
  
 // for the possibility of zone-specific certificates used in the signing 
  
 // process. 
  
 Parent 
  
  string 
 
  
 `protobuf:"bytes,2,opt,name=parent,proto3" json:"parent,omitempty"` 
  
 // contains filtered or unexported fields 
 } 
 

func (*SignSshPublicKeyRequest) Descriptor

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

Deprecated: Use SignSshPublicKeyRequest.ProtoReflect.Descriptor instead.

func (*SignSshPublicKeyRequest) GetParent

  func 
  
 ( 
 x 
  
 * 
  SignSshPublicKeyRequest 
 
 ) 
  
 GetParent 
 () 
  
  string 
 
 

func (*SignSshPublicKeyRequest) GetSshPublicKey

  func 
  
 ( 
 x 
  
 * 
  SignSshPublicKeyRequest 
 
 ) 
  
 GetSshPublicKey 
 () 
  
  string 
 
 

func (*SignSshPublicKeyRequest) ProtoMessage

  func 
  
 ( 
 * 
  SignSshPublicKeyRequest 
 
 ) 
  
 ProtoMessage 
 () 
 

func (*SignSshPublicKeyRequest) ProtoReflect

func (*SignSshPublicKeyRequest) Reset

  func 
  
 ( 
 x 
  
 * 
  SignSshPublicKeyRequest 
 
 ) 
  
 Reset 
 () 
 

func (*SignSshPublicKeyRequest) String

  func 
  
 ( 
 x 
  
 * 
  SignSshPublicKeyRequest 
 
 ) 
  
 String 
 () 
  
  string 
 
 

SignSshPublicKeyResponse

  type 
  
 SignSshPublicKeyResponse 
  
 struct 
  
 { 
  
 // The signed SSH public key to use in the SSH handshake. 
  
 SignedSshPublicKey 
  
  string 
 
  
 `protobuf:"bytes,1,opt,name=signed_ssh_public_key,json=signedSshPublicKey,proto3" json:"signed_ssh_public_key,omitempty"` 
  
 // contains filtered or unexported fields 
 } 
 

func (*SignSshPublicKeyResponse) Descriptor

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

Deprecated: Use SignSshPublicKeyResponse.ProtoReflect.Descriptor instead.

func (*SignSshPublicKeyResponse) GetSignedSshPublicKey

  func 
  
 ( 
 x 
  
 * 
  SignSshPublicKeyResponse 
 
 ) 
  
 GetSignedSshPublicKey 
 () 
  
  string 
 
 

func (*SignSshPublicKeyResponse) ProtoMessage

  func 
  
 ( 
 * 
  SignSshPublicKeyResponse 
 
 ) 
  
 ProtoMessage 
 () 
 

func (*SignSshPublicKeyResponse) ProtoReflect

func (*SignSshPublicKeyResponse) Reset

  func 
  
 ( 
 x 
  
 * 
  SignSshPublicKeyResponse 
 
 ) 
  
 Reset 
 () 
 

func (*SignSshPublicKeyResponse) String

UnimplementedOsLoginServiceServer

  type 
  
 UnimplementedOsLoginServiceServer 
  
 struct 
  
 { 
 } 
 

UnimplementedOsLoginServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedOsLoginServiceServer) CreateSshPublicKey

func (*UnimplementedOsLoginServiceServer) DeletePosixAccount

func (*UnimplementedOsLoginServiceServer) DeleteSshPublicKey

func (*UnimplementedOsLoginServiceServer) GetLoginProfile

func (*UnimplementedOsLoginServiceServer) GetSshPublicKey

func (*UnimplementedOsLoginServiceServer) ImportSshPublicKey

func (*UnimplementedOsLoginServiceServer) SignSshPublicKey

func (*UnimplementedOsLoginServiceServer) UpdateSshPublicKey

UniversalTwoFactor

  type 
  
 UniversalTwoFactor 
  
 struct 
  
 { 
  
 // Application ID for the U2F protocol. 
  
 AppId 
  
  string 
 
  
 `protobuf:"bytes,1,opt,name=app_id,json=appId,proto3" json:"app_id,omitempty"` 
  
 // contains filtered or unexported fields 
 } 
 

Security key information specific to the U2F protocol.

func (*UniversalTwoFactor) Descriptor

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

Deprecated: Use UniversalTwoFactor.ProtoReflect.Descriptor instead.

func (*UniversalTwoFactor) GetAppId

  func 
  
 ( 
 x 
  
 * 
  UniversalTwoFactor 
 
 ) 
  
 GetAppId 
 () 
  
  string 
 
 

func (*UniversalTwoFactor) ProtoMessage

  func 
  
 ( 
 * 
  UniversalTwoFactor 
 
 ) 
  
 ProtoMessage 
 () 
 

func (*UniversalTwoFactor) ProtoReflect

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

func (*UniversalTwoFactor) Reset

  func 
  
 ( 
 x 
  
 * 
  UniversalTwoFactor 
 
 ) 
  
 Reset 
 () 
 

func (*UniversalTwoFactor) String

  func 
  
 ( 
 x 
  
 * 
  UniversalTwoFactor 
 
 ) 
  
 String 
 () 
  
  string 
 
 

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 (*UpdateSshPublicKeyRequest) GetSshPublicKey

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

func (*UpdateSshPublicKeyRequest) GetUpdateMask

func (*UpdateSshPublicKeyRequest) ProtoMessage

  func 
  
 ( 
 * 
  UpdateSshPublicKeyRequest 
 
 ) 
  
 ProtoMessage 
 () 
 

func (*UpdateSshPublicKeyRequest) ProtoReflect

func (*UpdateSshPublicKeyRequest) Reset

  func 
  
 ( 
 x 
  
 * 
  UpdateSshPublicKeyRequest 
 
 ) 
  
 Reset 
 () 
 

func (*UpdateSshPublicKeyRequest) String

WebAuthn

  type 
  
 WebAuthn 
  
 struct 
  
 { 
  
 // Relying party ID for Web Authentication. 
  
 RpId 
  
  string 
 
  
 `protobuf:"bytes,1,opt,name=rp_id,json=rpId,proto3" json:"rp_id,omitempty"` 
  
 // contains filtered or unexported fields 
 } 
 

Security key information specific to the Web Authentication protocol.

func (*WebAuthn) Descriptor

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

Deprecated: Use WebAuthn.ProtoReflect.Descriptor instead.

func (*WebAuthn) GetRpId

  func 
  
 ( 
 x 
  
 * 
  WebAuthn 
 
 ) 
  
 GetRpId 
 () 
  
  string 
 
 

func (*WebAuthn) ProtoMessage

  func 
  
 ( 
 * 
  WebAuthn 
 
 ) 
  
 ProtoMessage 
 () 
 

func (*WebAuthn) ProtoReflect

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

func (*WebAuthn) Reset

  func 
  
 ( 
 x 
  
 * 
  WebAuthn 
 
 ) 
  
 Reset 
 () 
 

func (*WebAuthn) String

  func 
  
 ( 
 x 
  
 * 
  WebAuthn 
 
 ) 
  
 String 
 () 
  
  string 
 
 
Design a Mobile Site
View Site in Mobile | Classic
Share by: