api: google.golang.org/api/oslogin/v1alpha Index | Files

package oslogin

import "google.golang.org/api/oslogin/v1alpha"

Package oslogin provides access to the Cloud OS Login API.

This package is DEPRECATED. Use package cloud.google.com/go/oslogin/apiv1 instead.

For product documentation, see: https://cloud.google.com/compute/docs/oslogin/

Creating a client

Usage example:

import "google.golang.org/api/oslogin/v1alpha"
...
ctx := context.Background()
osloginService, err := oslogin.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication.

For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use option.WithScopes:

osloginService, err := oslogin.NewService(ctx, option.WithScopes(oslogin.ComputeReadonlyScope))

To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:

osloginService, err := oslogin.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
osloginService, err := oslogin.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See https://godoc.org/google.golang.org/api/option/ for details on options.

Index

Package Files

oslogin-gen.go

Constants

const (
    // View and manage your data across Google Cloud Platform services
    CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"

    // View your data across Google Cloud Platform services
    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"
)

OAuth2 scopes used by this API.

type Empty Uses

type Empty struct {
    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`
}

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

}

The JSON representation for `Empty` is empty JSON object `{}`.

type ImportSshPublicKeyResponse Uses

type ImportSshPublicKeyResponse struct {
    // 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. "LoginProfile") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "LoginProfile") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

ImportSshPublicKeyResponse: A response message from importing an SSH public key.

func (*ImportSshPublicKeyResponse) MarshalJSON Uses

func (s *ImportSshPublicKeyResponse) MarshalJSON() ([]byte, error)

type LoginProfile Uses

type LoginProfile struct {
    // Name: 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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

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

func (*LoginProfile) MarshalJSON Uses

func (s *LoginProfile) MarshalJSON() ([]byte, error)

type PosixAccount Uses

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"`

    // 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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

PosixAccount: The POSIX account information associated with a Google account.

func (*PosixAccount) MarshalJSON Uses

func (s *PosixAccount) MarshalJSON() ([]byte, error)

type Service Uses

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 Uses

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 Uses

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

type SshPublicKey Uses

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
    // <a href="https://www.ietf.org/rfc/rfc4253.txt"
    // target="_blank">RFC4253</a>
    // section 6.6.
    Key string `json:"key,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 values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    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. However, any field
    // with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

SshPublicKey: The SSH public key information associated with a Google account.

func (*SshPublicKey) MarshalJSON Uses

func (s *SshPublicKey) MarshalJSON() ([]byte, error)

type UsersGetLoginProfileCall Uses

type UsersGetLoginProfileCall struct {
    // contains filtered or unexported fields
}

func (*UsersGetLoginProfileCall) Context Uses

func (c *UsersGetLoginProfileCall) Context(ctx context.Context) *UsersGetLoginProfileCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*UsersGetLoginProfileCall) Do Uses

func (c *UsersGetLoginProfileCall) Do(opts ...googleapi.CallOption) (*LoginProfile, error)

Do executes the "oslogin.users.getLoginProfile" call. Exactly one of *LoginProfile or error will be non-nil. 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 (*UsersGetLoginProfileCall) Fields Uses

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 information.

func (*UsersGetLoginProfileCall) Header Uses

func (c *UsersGetLoginProfileCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*UsersGetLoginProfileCall) IfNoneMatch Uses

func (c *UsersGetLoginProfileCall) IfNoneMatch(entityTag string) *UsersGetLoginProfileCall

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*UsersGetLoginProfileCall) OperatingSystemType Uses

func (c *UsersGetLoginProfileCall) OperatingSystemType(operatingSystemType string) *UsersGetLoginProfileCall

OperatingSystemType sets the optional parameter "operatingSystemType": The type of operating system associated with the account.

Possible values:

"OPERATING_SYSTEM_TYPE_UNSPECIFIED"
"LINUX"
"WINDOWS"

func (*UsersGetLoginProfileCall) ProjectId Uses

func (c *UsersGetLoginProfileCall) ProjectId(projectId string) *UsersGetLoginProfileCall

ProjectId sets the optional parameter "projectId": The project ID of the Google Cloud Platform project.

func (*UsersGetLoginProfileCall) SystemId Uses

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 Uses

type UsersImportSshPublicKeyCall struct {
    // contains filtered or unexported fields
}

func (*UsersImportSshPublicKeyCall) Context Uses

func (c *UsersImportSshPublicKeyCall) Context(ctx context.Context) *UsersImportSshPublicKeyCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*UsersImportSshPublicKeyCall) Do Uses

func (c *UsersImportSshPublicKeyCall) Do(opts ...googleapi.CallOption) (*ImportSshPublicKeyResponse, error)

Do executes the "oslogin.users.importSshPublicKey" call. Exactly one of *ImportSshPublicKeyResponse or error will be non-nil. 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 (*UsersImportSshPublicKeyCall) Fields Uses

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 information.

func (*UsersImportSshPublicKeyCall) Header Uses

func (c *UsersImportSshPublicKeyCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*UsersImportSshPublicKeyCall) ProjectId Uses

func (c *UsersImportSshPublicKeyCall) ProjectId(projectId string) *UsersImportSshPublicKeyCall

ProjectId sets the optional parameter "projectId": The project ID of the Google Cloud Platform project.

type UsersProjectsDeleteCall Uses

type UsersProjectsDeleteCall struct {
    // contains filtered or unexported fields
}

func (*UsersProjectsDeleteCall) Context Uses

func (c *UsersProjectsDeleteCall) Context(ctx context.Context) *UsersProjectsDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*UsersProjectsDeleteCall) Do Uses

func (c *UsersProjectsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "oslogin.users.projects.delete" call. Exactly one of *Empty or error will be non-nil. 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 (*UsersProjectsDeleteCall) Fields Uses

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 information.

func (*UsersProjectsDeleteCall) Header Uses

func (c *UsersProjectsDeleteCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*UsersProjectsDeleteCall) OperatingSystemType Uses

func (c *UsersProjectsDeleteCall) OperatingSystemType(operatingSystemType string) *UsersProjectsDeleteCall

OperatingSystemType sets the optional parameter "operatingSystemType": The type of operating system associated with the account.

Possible values:

"OPERATING_SYSTEM_TYPE_UNSPECIFIED"
"LINUX"
"WINDOWS"

type UsersProjectsService Uses

type UsersProjectsService struct {
    // contains filtered or unexported fields
}

func NewUsersProjectsService Uses

func NewUsersProjectsService(s *Service) *UsersProjectsService

func (*UsersProjectsService) Delete Uses

func (r *UsersProjectsService) Delete(name string) *UsersProjectsDeleteCall

Delete: Deletes a POSIX account.

type UsersService Uses

type UsersService struct {
    Projects *UsersProjectsService

    SshPublicKeys *UsersSshPublicKeysService
    // contains filtered or unexported fields
}

func NewUsersService Uses

func NewUsersService(s *Service) *UsersService

func (*UsersService) GetLoginProfile Uses

func (r *UsersService) GetLoginProfile(name string) *UsersGetLoginProfileCall

GetLoginProfile: Retrieves the profile information used for logging in to a virtual machine on Google Compute Engine.

func (*UsersService) ImportSshPublicKey Uses

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.

type UsersSshPublicKeysDeleteCall Uses

type UsersSshPublicKeysDeleteCall struct {
    // contains filtered or unexported fields
}

func (*UsersSshPublicKeysDeleteCall) Context Uses

func (c *UsersSshPublicKeysDeleteCall) Context(ctx context.Context) *UsersSshPublicKeysDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*UsersSshPublicKeysDeleteCall) Do Uses

func (c *UsersSshPublicKeysDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "oslogin.users.sshPublicKeys.delete" call. Exactly one of *Empty or error will be non-nil. 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 (*UsersSshPublicKeysDeleteCall) Fields Uses

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 information.

func (*UsersSshPublicKeysDeleteCall) Header Uses

func (c *UsersSshPublicKeysDeleteCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type UsersSshPublicKeysGetCall Uses

type UsersSshPublicKeysGetCall struct {
    // contains filtered or unexported fields
}

func (*UsersSshPublicKeysGetCall) Context Uses

func (c *UsersSshPublicKeysGetCall) Context(ctx context.Context) *UsersSshPublicKeysGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*UsersSshPublicKeysGetCall) Do Uses

func (c *UsersSshPublicKeysGetCall) Do(opts ...googleapi.CallOption) (*SshPublicKey, error)

Do executes the "oslogin.users.sshPublicKeys.get" call. Exactly one of *SshPublicKey or error will be non-nil. 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 (*UsersSshPublicKeysGetCall) Fields Uses

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 information.

func (*UsersSshPublicKeysGetCall) Header Uses

func (c *UsersSshPublicKeysGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*UsersSshPublicKeysGetCall) IfNoneMatch Uses

func (c *UsersSshPublicKeysGetCall) IfNoneMatch(entityTag string) *UsersSshPublicKeysGetCall

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type UsersSshPublicKeysPatchCall Uses

type UsersSshPublicKeysPatchCall struct {
    // contains filtered or unexported fields
}

func (*UsersSshPublicKeysPatchCall) Context Uses

func (c *UsersSshPublicKeysPatchCall) Context(ctx context.Context) *UsersSshPublicKeysPatchCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*UsersSshPublicKeysPatchCall) Do Uses

func (c *UsersSshPublicKeysPatchCall) Do(opts ...googleapi.CallOption) (*SshPublicKey, error)

Do executes the "oslogin.users.sshPublicKeys.patch" call. Exactly one of *SshPublicKey or error will be non-nil. 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 (*UsersSshPublicKeysPatchCall) Fields Uses

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 information.

func (*UsersSshPublicKeysPatchCall) Header Uses

func (c *UsersSshPublicKeysPatchCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*UsersSshPublicKeysPatchCall) UpdateMask Uses

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 Uses

type UsersSshPublicKeysService struct {
    // contains filtered or unexported fields
}

func NewUsersSshPublicKeysService Uses

func NewUsersSshPublicKeysService(s *Service) *UsersSshPublicKeysService

func (*UsersSshPublicKeysService) Delete Uses

func (r *UsersSshPublicKeysService) Delete(name string) *UsersSshPublicKeysDeleteCall

Delete: Deletes an SSH public key.

func (*UsersSshPublicKeysService) Get Uses

func (r *UsersSshPublicKeysService) Get(name string) *UsersSshPublicKeysGetCall

Get: Retrieves an SSH public key.

func (*UsersSshPublicKeysService) Patch Uses

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.

Package oslogin imports 14 packages (graph). Updated 2019-07-17. Refresh now. Tools for package owners.