google-cloud-os_login 0.1.0

data/lib/google/cloud/os_login/v1beta/doc/google/cloud/oslogin/common.rb

@@ -0,0 +1,66 @@
+# Copyright 2017 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Google
+  module Cloud
+    module Oslogin
+      module Common
+        # The POSIX account information associated with a Google account.
+        # @!attribute [rw] primary
+        #   @return [true, false]
+        #     Only one POSIX account can be marked as primary.
+        # @!attribute [rw] username
+        #   @return [String]
+        #     The username of the POSIX account.
+        # @!attribute [rw] uid
+        #   @return [Integer]
+        #     The user ID.
+        # @!attribute [rw] gid
+        #   @return [Integer]
+        #     The default group ID.
+        # @!attribute [rw] home_directory
+        #   @return [String]
+        #     The path to the home directory for this account.
+        # @!attribute [rw] shell
+        #   @return [String]
+        #     The path to the logic shell for this account.
+        # @!attribute [rw] gecos
+        #   @return [String]
+        #     The GECOS (user information) entry for this account.
+        # @!attribute [rw] system_id
+        #   @return [String]
+        #     System identifier for which account the username or uid applies to.
+        #     By default, the empty value is used.
+        # @!attribute [rw] account_id
+        #   @return [String]
+        #     Output only. A POSIX account identifier.
+        class PosixAccount; end
+
+        # The SSH public key information associated with a Google account.
+        # @!attribute [rw] key
+        #   @return [String]
+        #     Public key text in SSH format, defined by
+        #     <a href="https://www.ietf.org/rfc/rfc4253.txt" target="_blank">RFC4253</a>
+        #     section 6.6.
+        # @!attribute [rw] expiration_time_usec
+        #   @return [Integer]
+        #     An expiration time in microseconds since epoch.
+        # @!attribute [rw] fingerprint
+        #   @return [String]
+        #     Output only. The SHA-256 fingerprint of the SSH public key.
+        class SshPublicKey; end
+      end
+    end
+  end
+end

data/lib/google/cloud/os_login/v1beta/doc/google/cloud/oslogin/v1beta/oslogin.rb

@@ -0,0 +1,111 @@
+# Copyright 2017 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Google
+  module Cloud
+    module Oslogin
+      ##
+      # # Google Cloud OS Login API Contents
+      #
+      # | Class | Description |
+      # | ----- | ----------- |
+      # | [OsLoginServiceClient][] | Manages OS login configuration for Google account users. |
+      # | [Data Types][] | Data types for Google::Cloud::OsLogin::V1beta |
+      #
+      # [OsLoginServiceClient]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-os_login/latest/google/cloud/oslogin/v1beta/osloginserviceclient
+      # [Data Types]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-os_login/latest/google/cloud/oslogin/v1beta/datatypes
+      #
+      module V1beta
+        # The user profile information used for logging in to a virtual machine on
+        # Google Compute Engine.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     The primary email address that uniquely identifies the user.
+        # @!attribute [rw] posix_accounts
+        #   @return [Array<Google::Cloud::Oslogin::Common::PosixAccount>]
+        #     The list of POSIX accounts associated with the user.
+        # @!attribute [rw] ssh_public_keys
+        #   @return [Hash{String => Google::Cloud::Oslogin::Common::SshPublicKey}]
+        #     A map from SSH public key fingerprint to the associated key object.
+        # @!attribute [rw] suspended
+        #   @return [true, false]
+        #     Indicates if the user is suspended. A suspended user cannot log in but
+        #     their profile information is retained.
+        class LoginProfile; end
+
+        # A request message for deleting a POSIX account entry.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     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}+.
+        class DeletePosixAccountRequest; end
+
+        # A request message for deleting an SSH public key.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     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}+.
+        class DeleteSshPublicKeyRequest; end
+
+        # A request message for retrieving the login profile information for a user.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     The unique ID for the user in format +users/{user}+.
+        class GetLoginProfileRequest; end
+
+        # A request message for retrieving an SSH public key.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     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}+.
+        class GetSshPublicKeyRequest; end
+
+        # A request message for importing an SSH public key.
+        # @!attribute [rw] parent
+        #   @return [String]
+        #     The unique ID for the user in format +users/{user}+.
+        # @!attribute [rw] ssh_public_key
+        #   @return [Google::Cloud::Oslogin::Common::SshPublicKey]
+        #     The SSH public key and expiration time.
+        # @!attribute [rw] project_id
+        #   @return [String]
+        #     The project ID of the Google Cloud Platform project.
+        class ImportSshPublicKeyRequest; end
+
+        # A response message for importing an SSH public key.
+        # @!attribute [rw] login_profile
+        #   @return [Google::Cloud::Oslogin::V1beta::LoginProfile]
+        #     The login profile information for the user.
+        class ImportSshPublicKeyResponse; end
+
+        # A request message for updating an SSH public key.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     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}+.
+        # @!attribute [rw] ssh_public_key
+        #   @return [Google::Cloud::Oslogin::Common::SshPublicKey]
+        #     The SSH public key and expiration time.
+        # @!attribute [rw] update_mask
+        #   @return [Google::Protobuf::FieldMask]
+        #     Mask to control which fields get updated. Updates all if not present.
+        class UpdateSshPublicKeyRequest; end
+      end
+    end
+  end
+end

data/lib/google/cloud/os_login/v1beta/doc/google/protobuf/field_mask.rb

@@ -0,0 +1,223 @@
+# Copyright 2017 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Google
+  module Protobuf
+    # +FieldMask+ represents a set of symbolic field paths, for example:
+    #
+    #     paths: "f.a"
+    #     paths: "f.b.d"
+    #
+    # Here +f+ represents a field in some root message, +a+ and +b+
+    # fields in the message found in +f+, and +d+ a field found in the
+    # message in +f.b+.
+    #
+    # Field masks are used to specify a subset of fields that should be
+    # returned by a get operation or modified by an update operation.
+    # Field masks also have a custom JSON encoding (see below).
+    #
+    # = Field Masks in Projections
+    #
+    # When used in the context of a projection, a response message or
+    # sub-message is filtered by the API to only contain those fields as
+    # specified in the mask. For example, if the mask in the previous
+    # example is applied to a response message as follows:
+    #
+    #     f {
+    #       a : 22
+    #       b {
+    #         d : 1
+    #         x : 2
+    #       }
+    #       y : 13
+    #     }
+    #     z: 8
+    #
+    # The result will not contain specific values for fields x,y and z
+    # (their value will be set to the default, and omitted in proto text
+    # output):
+    #
+    #
+    #     f {
+    #       a : 22
+    #       b {
+    #         d : 1
+    #       }
+    #     }
+    #
+    # A repeated field is not allowed except at the last position of a
+    # paths string.
+    #
+    # If a FieldMask object is not present in a get operation, the
+    # operation applies to all fields (as if a FieldMask of all fields
+    # had been specified).
+    #
+    # Note that a field mask does not necessarily apply to the
+    # top-level response message. In case of a REST get operation, the
+    # field mask applies directly to the response, but in case of a REST
+    # list operation, the mask instead applies to each individual message
+    # in the returned resource list. In case of a REST custom method,
+    # other definitions may be used. Where the mask applies will be
+    # clearly documented together with its declaration in the API.  In
+    # any case, the effect on the returned resource/resources is required
+    # behavior for APIs.
+    #
+    # = Field Masks in Update Operations
+    #
+    # A field mask in update operations specifies which fields of the
+    # targeted resource are going to be updated. The API is required
+    # to only change the values of the fields as specified in the mask
+    # and leave the others untouched. If a resource is passed in to
+    # describe the updated values, the API ignores the values of all
+    # fields not covered by the mask.
+    #
+    # If a repeated field is specified for an update operation, the existing
+    # repeated values in the target resource will be overwritten by the new values.
+    # Note that a repeated field is only allowed in the last position of a +paths+
+    # string.
+    #
+    # If a sub-message is specified in the last position of the field mask for an
+    # update operation, then the existing sub-message in the target resource is
+    # overwritten. Given the target message:
+    #
+    #     f {
+    #       b {
+    #         d : 1
+    #         x : 2
+    #       }
+    #       c : 1
+    #     }
+    #
+    # And an update message:
+    #
+    #     f {
+    #       b {
+    #         d : 10
+    #       }
+    #     }
+    #
+    # then if the field mask is:
+    #
+    #  paths: "f.b"
+    #
+    # then the result will be:
+    #
+    #     f {
+    #       b {
+    #         d : 10
+    #       }
+    #       c : 1
+    #     }
+    #
+    # However, if the update mask was:
+    #
+    #  paths: "f.b.d"
+    #
+    # then the result would be:
+    #
+    #     f {
+    #       b {
+    #         d : 10
+    #         x : 2
+    #       }
+    #       c : 1
+    #     }
+    #
+    # In order to reset a field's value to the default, the field must
+    # be in the mask and set to the default value in the provided resource.
+    # Hence, in order to reset all fields of a resource, provide a default
+    # instance of the resource and set all fields in the mask, or do
+    # not provide a mask as described below.
+    #
+    # If a field mask is not present on update, the operation applies to
+    # all fields (as if a field mask of all fields has been specified).
+    # Note that in the presence of schema evolution, this may mean that
+    # fields the client does not know and has therefore not filled into
+    # the request will be reset to their default. If this is unwanted
+    # behavior, a specific service may require a client to always specify
+    # a field mask, producing an error if not.
+    #
+    # As with get operations, the location of the resource which
+    # describes the updated values in the request message depends on the
+    # operation kind. In any case, the effect of the field mask is
+    # required to be honored by the API.
+    #
+    # == Considerations for HTTP REST
+    #
+    # The HTTP kind of an update operation which uses a field mask must
+    # be set to PATCH instead of PUT in order to satisfy HTTP semantics
+    # (PUT must only be used for full updates).
+    #
+    # = JSON Encoding of Field Masks
+    #
+    # In JSON, a field mask is encoded as a single string where paths are
+    # separated by a comma. Fields name in each path are converted
+    # to/from lower-camel naming conventions.
+    #
+    # As an example, consider the following message declarations:
+    #
+    #     message Profile {
+    #       User user = 1;
+    #       Photo photo = 2;
+    #     }
+    #     message User {
+    #       string display_name = 1;
+    #       string address = 2;
+    #     }
+    #
+    # In proto a field mask for +Profile+ may look as such:
+    #
+    #     mask {
+    #       paths: "user.display_name"
+    #       paths: "photo"
+    #     }
+    #
+    # In JSON, the same mask is represented as below:
+    #
+    #     {
+    #       mask: "user.displayName,photo"
+    #     }
+    #
+    # = Field Masks and Oneof Fields
+    #
+    # Field masks treat fields in oneofs just as regular fields. Consider the
+    # following message:
+    #
+    #     message SampleMessage {
+    #       oneof test_oneof {
+    #         string name = 4;
+    #         SubMessage sub_message = 9;
+    #       }
+    #     }
+    #
+    # The field mask can be:
+    #
+    #     mask {
+    #       paths: "name"
+    #     }
+    #
+    # Or:
+    #
+    #     mask {
+    #       paths: "sub_message"
+    #     }
+    #
+    # Note that oneof type names ("test_oneof" in this case) cannot be used in
+    # paths.
+    # @!attribute [rw] paths
+    #   @return [Array<String>]
+    #     The set of field mask paths.
+    class FieldMask; end
+  end
+end

data/lib/google/cloud/os_login/v1beta/doc/overview.rb

@@ -0,0 +1,54 @@
+# Copyright 2017 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Google
+  module Cloud
+    # rubocop:disable LineLength
+
+    ##
+    # # Ruby Client for Google Cloud OS Login API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
+    #
+    # [Google Cloud OS Login API][Product Documentation]:
+    # Manages OS login configuration for Google account users.
+    # - [Product Documentation][]
+    #
+    # ## Quick Start
+    # In order to use this library, you first need to go through the following
+    # steps:
+    #
+    # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
+    # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
+    # 3. [Enable the Google Cloud OS Login API.](https://console.cloud.google.com/apis/api/oslogin)
+    # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
+    #
+    # ### Installation
+    # ```
+    # $ gem install google-cloud-os_login
+    # ```
+    #
+    # ### Next Steps
+    # - Read the [Google Cloud OS Login API Product documentation][Product Documentation]
+    #   to learn more about the product and see How-to Guides.
+    # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
+    #   to see the full list of Cloud APIs that we cover.
+    #
+    # [Product Documentation]: https://cloud.google.com/compute/docs/oslogin/rest/
+    #
+    #
+    module OsLogin
+      module V1beta
+      end
+    end
+  end
+end