OAuth2 scopes used by this API.
const (
// See, edit, configure, and delete your Google Cloud data and see the email
// address for your Google Account.
CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
// View your data across Google Cloud services and see the email address of
// your Google Account
CloudPlatformReadOnlyScope = "https://www.googleapis.com/auth/cloud-platform.read-only"
// View and manage your Google Compute Engine resources
ComputeScope = "https://www.googleapis.com/auth/compute"
// View your Google Compute Engine resources
ComputeReadonlyScope = "https://www.googleapis.com/auth/compute.readonly"
)
Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
type Empty struct {
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
}
ImportSshPublicKeyResponse: A response message for importing an SSH public key.
type ImportSshPublicKeyResponse struct {
// Details: Detailed information about import results.
Details string `json:"details,omitempty"`
// LoginProfile: The login profile information for the user.
LoginProfile *LoginProfile `json:"loginProfile,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Details") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Details") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ImportSshPublicKeyResponse) MarshalJSON() ([]byte, error)
LoginProfile: The user profile information used for logging in to a virtual machine on Google Compute Engine.
type LoginProfile struct {
// Name: Required. A unique user ID.
Name string `json:"name,omitempty"`
// PosixAccounts: The list of POSIX accounts associated with the user.
PosixAccounts []*PosixAccount `json:"posixAccounts,omitempty"`
// SshPublicKeys: A map from SSH public key fingerprint to the associated key
// object.
SshPublicKeys map[string]SshPublicKey `json:"sshPublicKeys,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Name") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Name") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *LoginProfile) MarshalJSON() ([]byte, error)
PosixAccount: The POSIX account information associated with a Google account.
type PosixAccount struct {
// AccountId: Output only. A POSIX account identifier.
AccountId string `json:"accountId,omitempty"`
// Gecos: The GECOS (user information) entry for this account.
Gecos string `json:"gecos,omitempty"`
// Gid: The default group ID.
Gid int64 `json:"gid,omitempty,string"`
// HomeDirectory: The path to the home directory for this account.
HomeDirectory string `json:"homeDirectory,omitempty"`
// Name: Output only. The canonical resource name.
Name string `json:"name,omitempty"`
// OperatingSystemType: The operating system type where this account applies.
//
// Possible values:
// "OPERATING_SYSTEM_TYPE_UNSPECIFIED" - The operating system type associated
// with the user account information is unspecified.
// "LINUX" - Linux user account information.
// "WINDOWS" - Windows user account information.
OperatingSystemType string `json:"operatingSystemType,omitempty"`
// Primary: Only one POSIX account can be marked as primary.
Primary bool `json:"primary,omitempty"`
// Shell: The path to the logic shell for this account.
Shell string `json:"shell,omitempty"`
// SystemId: System identifier for which account the username or uid applies
// to. By default, the empty value is used.
SystemId string `json:"systemId,omitempty"`
// Uid: The user ID.
Uid int64 `json:"uid,omitempty,string"`
// Username: The username of the POSIX account.
Username string `json:"username,omitempty"`
// ForceSendFields is a list of field names (e.g. "AccountId") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AccountId") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *PosixAccount) MarshalJSON() ([]byte, error)
type Service struct {
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Users *UsersService
// contains filtered or unexported fields
}
func New(client *http.Client) (*Service, error)
New creates a new Service. It uses the provided http.Client for requests.
Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)
NewService creates a new Service.
SshPublicKey: The SSH public key information associated with a Google account.
type SshPublicKey struct {
// ExpirationTimeUsec: An expiration time in microseconds since epoch.
ExpirationTimeUsec int64 `json:"expirationTimeUsec,omitempty,string"`
// Fingerprint: Output only. The SHA-256 fingerprint of the SSH public key.
Fingerprint string `json:"fingerprint,omitempty"`
// Key: Public key text in SSH format, defined by RFC4253 section 6.6.
Key string `json:"key,omitempty"`
// Name: Output only. The canonical resource name.
Name string `json:"name,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "ExpirationTimeUsec") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ExpirationTimeUsec") to include
// in API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *SshPublicKey) MarshalJSON() ([]byte, error)
type UsersGetLoginProfileCall struct {
// contains filtered or unexported fields
}
func (c *UsersGetLoginProfileCall) Context(ctx context.Context) *UsersGetLoginProfileCall
Context sets the context to be used in this call's Do method.
func (c *UsersGetLoginProfileCall) Do(opts ...googleapi.CallOption) (*LoginProfile, error)
Do executes the "oslogin.users.getLoginProfile" call. Any non-2xx status code is an error. Response headers are in either *LoginProfile.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *UsersGetLoginProfileCall) Fields(s ...googleapi.Field) *UsersGetLoginProfileCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *UsersGetLoginProfileCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *UsersGetLoginProfileCall) IfNoneMatch(entityTag string) *UsersGetLoginProfileCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *UsersGetLoginProfileCall) ProjectId(projectId string) *UsersGetLoginProfileCall
ProjectId sets the optional parameter "projectId": The project ID of the Google Cloud Platform project.
func (c *UsersGetLoginProfileCall) SystemId(systemId string) *UsersGetLoginProfileCall
SystemId sets the optional parameter "systemId": A system ID for filtering the results of the request.
type UsersImportSshPublicKeyCall struct {
// contains filtered or unexported fields
}
func (c *UsersImportSshPublicKeyCall) Context(ctx context.Context) *UsersImportSshPublicKeyCall
Context sets the context to be used in this call's Do method.
func (c *UsersImportSshPublicKeyCall) Do(opts ...googleapi.CallOption) (*ImportSshPublicKeyResponse, error)
Do executes the "oslogin.users.importSshPublicKey" call. Any non-2xx status code is an error. Response headers are in either *ImportSshPublicKeyResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *UsersImportSshPublicKeyCall) Fields(s ...googleapi.Field) *UsersImportSshPublicKeyCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *UsersImportSshPublicKeyCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *UsersImportSshPublicKeyCall) ProjectId(projectId string) *UsersImportSshPublicKeyCall
ProjectId sets the optional parameter "projectId": The project ID of the Google Cloud Platform project.
func (c *UsersImportSshPublicKeyCall) Regions(regions ...string) *UsersImportSshPublicKeyCall
Regions sets the optional parameter "regions": 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.
type UsersProjectsDeleteCall struct {
// contains filtered or unexported fields
}
func (c *UsersProjectsDeleteCall) Context(ctx context.Context) *UsersProjectsDeleteCall
Context sets the context to be used in this call's Do method.
func (c *UsersProjectsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "oslogin.users.projects.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *UsersProjectsDeleteCall) Fields(s ...googleapi.Field) *UsersProjectsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *UsersProjectsDeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type UsersProjectsService struct {
// contains filtered or unexported fields
}
func NewUsersProjectsService(s *Service) *UsersProjectsService
func (r *UsersProjectsService) Delete(name string) *UsersProjectsDeleteCall
Delete: Deletes a POSIX account.
type UsersService struct {
Projects *UsersProjectsService
SshPublicKeys *UsersSshPublicKeysService
// contains filtered or unexported fields
}
func NewUsersService(s *Service) *UsersService
func (r *UsersService) GetLoginProfile(name string) *UsersGetLoginProfileCall
GetLoginProfile: Retrieves the profile information used for logging in to a virtual machine on Google Compute Engine.
- name: The unique ID for the user in format `users/{user}`.
func (r *UsersService) ImportSshPublicKey(parent string, sshpublickey *SshPublicKey) *UsersImportSshPublicKeyCall
ImportSshPublicKey: 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.
- parent: The unique ID for the user in format `users/{user}`.
type UsersSshPublicKeysCreateCall struct {
// contains filtered or unexported fields
}
func (c *UsersSshPublicKeysCreateCall) Context(ctx context.Context) *UsersSshPublicKeysCreateCall
Context sets the context to be used in this call's Do method.
func (c *UsersSshPublicKeysCreateCall) Do(opts ...googleapi.CallOption) (*SshPublicKey, error)
Do executes the "oslogin.users.sshPublicKeys.create" call. Any non-2xx status code is an error. Response headers are in either *SshPublicKey.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *UsersSshPublicKeysCreateCall) Fields(s ...googleapi.Field) *UsersSshPublicKeysCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *UsersSshPublicKeysCreateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type UsersSshPublicKeysDeleteCall struct {
// contains filtered or unexported fields
}
func (c *UsersSshPublicKeysDeleteCall) Context(ctx context.Context) *UsersSshPublicKeysDeleteCall
Context sets the context to be used in this call's Do method.
func (c *UsersSshPublicKeysDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "oslogin.users.sshPublicKeys.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *UsersSshPublicKeysDeleteCall) Fields(s ...googleapi.Field) *UsersSshPublicKeysDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *UsersSshPublicKeysDeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type UsersSshPublicKeysGetCall struct {
// contains filtered or unexported fields
}
func (c *UsersSshPublicKeysGetCall) Context(ctx context.Context) *UsersSshPublicKeysGetCall
Context sets the context to be used in this call's Do method.
func (c *UsersSshPublicKeysGetCall) Do(opts ...googleapi.CallOption) (*SshPublicKey, error)
Do executes the "oslogin.users.sshPublicKeys.get" call. Any non-2xx status code is an error. Response headers are in either *SshPublicKey.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *UsersSshPublicKeysGetCall) Fields(s ...googleapi.Field) *UsersSshPublicKeysGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *UsersSshPublicKeysGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *UsersSshPublicKeysGetCall) IfNoneMatch(entityTag string) *UsersSshPublicKeysGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type UsersSshPublicKeysPatchCall struct {
// contains filtered or unexported fields
}
func (c *UsersSshPublicKeysPatchCall) Context(ctx context.Context) *UsersSshPublicKeysPatchCall
Context sets the context to be used in this call's Do method.
func (c *UsersSshPublicKeysPatchCall) Do(opts ...googleapi.CallOption) (*SshPublicKey, error)
Do executes the "oslogin.users.sshPublicKeys.patch" call. Any non-2xx status code is an error. Response headers are in either *SshPublicKey.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *UsersSshPublicKeysPatchCall) Fields(s ...googleapi.Field) *UsersSshPublicKeysPatchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *UsersSshPublicKeysPatchCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *UsersSshPublicKeysPatchCall) UpdateMask(updateMask string) *UsersSshPublicKeysPatchCall
UpdateMask sets the optional parameter "updateMask": Mask to control which fields get updated. Updates all if not present.
type UsersSshPublicKeysService struct {
// contains filtered or unexported fields
}
func NewUsersSshPublicKeysService(s *Service) *UsersSshPublicKeysService
func (r *UsersSshPublicKeysService) Create(parent string, sshpublickey *SshPublicKey) *UsersSshPublicKeysCreateCall
Create: Create an SSH public key
- parent: The unique ID for the user in format `users/{user}`.
func (r *UsersSshPublicKeysService) Delete(name string) *UsersSshPublicKeysDeleteCall
Delete: Deletes an SSH public key.
func (r *UsersSshPublicKeysService) Get(name string) *UsersSshPublicKeysGetCall
Get: Retrieves an SSH public key.
func (r *UsersSshPublicKeysService) Patch(name string, sshpublickey *SshPublicKey) *UsersSshPublicKeysPatchCall
Patch: Updates an SSH public key and returns the profile information. This method supports patch semantics.