Documentation

Overview

Package oslogin is an auto-generated package for the Cloud OS Login API.

You can use OS Login to manage access to your VM instances using IAM roles.

Use of Context

The ctx passed to NewClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.

To close the open connection, use the Close() method.

For information about setting deadlines, reusing contexts, and more please visit pkg.go.dev/cloud.google.com/go.

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

func DefaultAuthScopes

func DefaultAuthScopes() []string

    DefaultAuthScopes reports the default set of authentication scopes to use with this package.

    Types

    type CallOptions

    type CallOptions struct {
    	DeletePosixAccount []gax.CallOption
    	DeleteSshPublicKey []gax.CallOption
    	GetLoginProfile    []gax.CallOption
    	GetSshPublicKey    []gax.CallOption
    	ImportSshPublicKey []gax.CallOption
    	UpdateSshPublicKey []gax.CallOption
    }

      CallOptions contains the retry settings for each method of Client.

      type Client

      type Client struct {
      
      	// The call options for this service.
      	CallOptions *CallOptions
      	// contains filtered or unexported fields
      }

        Client is a client for interacting with Cloud OS Login API.

        Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

        func NewClient

        func NewClient(ctx context.Context, opts ...option.ClientOption) (*Client, error)

        NewClient creates a new os login service client.

        Cloud OS Login API

        The Cloud OS Login API allows you to manage users and their associated SSH public keys for logging into virtual machines on Google Cloud Platform.

        Example
        Output:
        
        

        func (*Client) Close

        func (c *Client) Close() error

          Close closes the connection to the API service. The user should invoke this when the client is no longer required.

          func (*Client) Connection

          func (c *Client) Connection() *grpc.ClientConn

            Connection returns a connection to the API service.

            Deprecated.

            func (*Client) DeletePosixAccount

            func (c *Client) DeletePosixAccount(ctx context.Context, req *osloginpb.DeletePosixAccountRequest, opts ...gax.CallOption) error

              DeletePosixAccount deletes a POSIX account.

              Example
              Output:
              
              

              func (*Client) DeleteSshPublicKey

              func (c *Client) DeleteSshPublicKey(ctx context.Context, req *osloginpb.DeleteSshPublicKeyRequest, opts ...gax.CallOption) error

                DeleteSshPublicKey deletes an SSH public key.

                Example
                Output:
                
                

                func (*Client) GetLoginProfile

                func (c *Client) GetLoginProfile(ctx context.Context, req *osloginpb.GetLoginProfileRequest, opts ...gax.CallOption) (*osloginpb.LoginProfile, error)

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

                  Example
                  Output:
                  
                  

                  func (*Client) GetSshPublicKey

                  func (c *Client) GetSshPublicKey(ctx context.Context, req *osloginpb.GetSshPublicKeyRequest, opts ...gax.CallOption) (*commonpb.SshPublicKey, error)

                    GetSshPublicKey retrieves an SSH public key.

                    Example
                    Output:
                    
                    

                    func (*Client) ImportSshPublicKey

                      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.

                      Example
                      Output:
                      
                      

                      func (*Client) UpdateSshPublicKey

                      func (c *Client) UpdateSshPublicKey(ctx context.Context, req *osloginpb.UpdateSshPublicKeyRequest, opts ...gax.CallOption) (*commonpb.SshPublicKey, error)

                        UpdateSshPublicKey updates an SSH public key and returns the profile information. This method supports patch semantics.

                        Example
                        Output: