google-cloud-os_login-v1 0.9.0 → 0.11.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +72 -101
- data/lib/google/cloud/os_login/v1/os_login_service/client.rb +36 -9
- data/lib/google/cloud/os_login/v1/os_login_service/rest/client.rb +38 -8
- data/lib/google/cloud/os_login/v1/os_login_service/rest/service_stub.rb +14 -2
- data/lib/google/cloud/os_login/v1/version.rb +1 -1
- data/lib/google/cloud/oslogin/v1/oslogin_pb.rb +1 -1
- data/proto_docs/google/api/client.rb +14 -0
- data/proto_docs/google/cloud/oslogin/v1/oslogin.rb +5 -0
- metadata +5 -5
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 13fe928627c030529ce10ace5cfe03176c156c72a45c34490d24d60ae25a490e
|
|
4
|
+
data.tar.gz: 142f6bc0bb2e820906f5faa784018406dfa0ed7ecdd40fae6801a5da9e49c53d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 2a0a2a006977553467ca7478056e8794b402f48f0a8fdfdcf0b1af0e6ee4384ba5d4a1a94998f254709e95c0ea7b9ec74318e4e279e5e534a4dd9ed696103f8f
|
|
7
|
+
data.tar.gz: b5bc74e646d45359764e7b8f0cd581b009e4e14ff0696c539a7fb355b01c4ed0da5da0df5babeef0af34a95aa5013fcd24fc86043e608e712532234851e288c9
|
data/AUTHENTICATION.md
CHANGED
|
@@ -1,151 +1,122 @@
|
|
|
1
1
|
# Authentication
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
[
|
|
5
|
-
|
|
6
|
-
[Google Cloud Platform environments](#google-cloud-platform-environments) the
|
|
7
|
-
credentials will be discovered automatically. When running on other
|
|
8
|
-
environments, the Service Account credentials can be specified by providing the
|
|
9
|
-
path to the
|
|
10
|
-
[JSON keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys)
|
|
11
|
-
for the account (or the JSON itself) in
|
|
12
|
-
[environment variables](#environment-variables). Additionally, Cloud SDK
|
|
13
|
-
credentials can also be discovered automatically, but this is only recommended
|
|
14
|
-
during development.
|
|
3
|
+
The recommended way to authenticate to the google-cloud-os_login-v1 library is to use
|
|
4
|
+
[Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials).
|
|
5
|
+
To review all of your authentication options, see [Credentials lookup](#credential-lookup).
|
|
15
6
|
|
|
16
7
|
## Quickstart
|
|
17
8
|
|
|
18
|
-
|
|
19
|
-
|
|
9
|
+
The following example shows how to set up authentication for a local development
|
|
10
|
+
environment with your user credentials.
|
|
20
11
|
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
3. Initialize the client.
|
|
12
|
+
**NOTE:** This method is _not_ recommended for running in production. User credentials
|
|
13
|
+
should be used only during development.
|
|
26
14
|
|
|
27
|
-
|
|
28
|
-
|
|
15
|
+
1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk).
|
|
16
|
+
2. Set up a local ADC file with your user credentials:
|
|
29
17
|
|
|
30
|
-
|
|
18
|
+
```sh
|
|
19
|
+
gcloud auth application-default login
|
|
31
20
|
```
|
|
32
21
|
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
The google-cloud-os_login-v1 library aims to make authentication
|
|
36
|
-
as simple as possible, and provides several mechanisms to configure your system
|
|
37
|
-
without requiring **Service Account Credentials** directly in code.
|
|
38
|
-
|
|
39
|
-
**Credentials** are discovered in the following order:
|
|
40
|
-
|
|
41
|
-
1. Specify credentials in method arguments
|
|
42
|
-
2. Specify credentials in configuration
|
|
43
|
-
3. Discover credentials path in environment variables
|
|
44
|
-
4. Discover credentials JSON in environment variables
|
|
45
|
-
5. Discover credentials file in the Cloud SDK's path
|
|
46
|
-
6. Discover GCP credentials
|
|
47
|
-
|
|
48
|
-
### Google Cloud Platform environments
|
|
22
|
+
3. Write code as if already authenticated.
|
|
49
23
|
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
|
|
53
|
-
Code should be written as if already authenticated.
|
|
24
|
+
For more information about setting up authentication for a local development environment, see
|
|
25
|
+
[Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev).
|
|
54
26
|
|
|
55
|
-
|
|
27
|
+
## Credential Lookup
|
|
56
28
|
|
|
57
|
-
The
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
**Credentials JSON** file can be stored in the environment variable, or the
|
|
62
|
-
**Credentials JSON** itself can be stored for environments such as Docker
|
|
63
|
-
containers where writing files is difficult or not encouraged.
|
|
29
|
+
The google-cloud-os_login-v1 library provides several mechanisms to configure your system.
|
|
30
|
+
Generally, using Application Default Credentials to facilitate automatic
|
|
31
|
+
credentials discovery is the easist method. But if you need to explicitly specify
|
|
32
|
+
credentials, there are several methods available to you.
|
|
64
33
|
|
|
65
|
-
|
|
66
|
-
checks for credentials are configured on the service Credentials class (such as
|
|
67
|
-
{::Google::Cloud::OsLogin::V1::OsLoginService::Credentials}):
|
|
34
|
+
Credentials are accepted in the following ways, in the following order or precedence:
|
|
68
35
|
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
36
|
+
1. Credentials specified in method arguments
|
|
37
|
+
2. Credentials specified in configuration
|
|
38
|
+
3. Credentials pointed to or included in environment variables
|
|
39
|
+
4. Credentials found in local ADC file
|
|
40
|
+
5. Credentials returned by the metadata server for the attached service account (GCP)
|
|
74
41
|
|
|
75
|
-
|
|
76
|
-
require "google/cloud/os_login/v1"
|
|
77
|
-
|
|
78
|
-
ENV["OS_LOGIN_CREDENTIALS"] = "path/to/keyfile.json"
|
|
42
|
+
### Configuration
|
|
79
43
|
|
|
80
|
-
client
|
|
81
|
-
|
|
44
|
+
You can configure a path to a JSON credentials file, either for an individual client object or
|
|
45
|
+
globally, for all client objects. The JSON file can contain credentials created for
|
|
46
|
+
[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
|
|
47
|
+
[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
|
|
48
|
+
[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
|
|
82
49
|
|
|
83
|
-
|
|
50
|
+
Note: Service account keys are a security risk if not managed correctly. You should
|
|
51
|
+
[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
|
|
52
|
+
whenever possible.
|
|
84
53
|
|
|
85
|
-
|
|
86
|
-
it in an environment variable. Either on an individual client initialization:
|
|
54
|
+
To configure a credentials file for an individual client initialization:
|
|
87
55
|
|
|
88
56
|
```ruby
|
|
89
57
|
require "google/cloud/os_login/v1"
|
|
90
58
|
|
|
91
59
|
client = ::Google::Cloud::OsLogin::V1::OsLoginService::Client.new do |config|
|
|
92
|
-
config.credentials = "path/to/
|
|
60
|
+
config.credentials = "path/to/credentialfile.json"
|
|
93
61
|
end
|
|
94
62
|
```
|
|
95
63
|
|
|
96
|
-
|
|
64
|
+
To configure a credentials file globally for all clients:
|
|
97
65
|
|
|
98
66
|
```ruby
|
|
99
67
|
require "google/cloud/os_login/v1"
|
|
100
68
|
|
|
101
69
|
::Google::Cloud::OsLogin::V1::OsLoginService::Client.configure do |config|
|
|
102
|
-
config.credentials = "path/to/
|
|
70
|
+
config.credentials = "path/to/credentialfile.json"
|
|
103
71
|
end
|
|
104
72
|
|
|
105
73
|
client = ::Google::Cloud::OsLogin::V1::OsLoginService::Client.new
|
|
106
74
|
```
|
|
107
75
|
|
|
108
|
-
###
|
|
76
|
+
### Environment Variables
|
|
109
77
|
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
78
|
+
You can also use an environment variable to provide a JSON credentials file.
|
|
79
|
+
The environment variable can contain a path to the credentials file or, for
|
|
80
|
+
environments such as Docker containers where writing files is not encouraged,
|
|
81
|
+
you can include the credentials file itself.
|
|
113
82
|
|
|
114
|
-
|
|
83
|
+
The JSON file can contain credentials created for
|
|
84
|
+
[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
|
|
85
|
+
[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
|
|
86
|
+
[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
|
|
115
87
|
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
88
|
+
Note: Service account keys are a security risk if not managed correctly. You should
|
|
89
|
+
[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
|
|
90
|
+
whenever possible.
|
|
91
|
+
|
|
92
|
+
The environment variables that google-cloud-os_login-v1
|
|
93
|
+
checks for credentials are:
|
|
119
94
|
|
|
120
|
-
|
|
121
|
-
*
|
|
95
|
+
* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
|
|
96
|
+
* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
|
|
122
97
|
|
|
123
|
-
|
|
98
|
+
```ruby
|
|
99
|
+
require "google/cloud/os_login/v1"
|
|
124
100
|
|
|
125
|
-
|
|
126
|
-
connect to the APIs. You will use the **JSON key file** to
|
|
127
|
-
connect to most services with google-cloud-os_login-v1.
|
|
101
|
+
ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
|
|
128
102
|
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
need a Google Developers service account.
|
|
103
|
+
client = ::Google::Cloud::OsLogin::V1::OsLoginService::Client.new
|
|
104
|
+
```
|
|
132
105
|
|
|
133
|
-
|
|
134
|
-
2. Create a new project or click on an existing project.
|
|
135
|
-
3. Activate the menu in the upper left and select **APIs & Services**. From
|
|
136
|
-
here, you will enable the APIs that your application requires.
|
|
106
|
+
### Local ADC file
|
|
137
107
|
|
|
138
|
-
|
|
108
|
+
You can set up a local ADC file with your user credentials for authentication during
|
|
109
|
+
development. If credentials are not provided in code or in environment variables,
|
|
110
|
+
then the local ADC credentials are discovered.
|
|
139
111
|
|
|
140
|
-
|
|
112
|
+
Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
|
|
141
113
|
|
|
142
|
-
|
|
143
|
-
"Service account" to be guided through downloading a new JSON key file.
|
|
114
|
+
### Google Cloud Platform environments
|
|
144
115
|
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
116
|
+
When running on Google Cloud Platform (GCP), including Google Compute Engine
|
|
117
|
+
(GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
|
|
118
|
+
Functions (GCF) and Cloud Run, credentials are retrieved from the attached
|
|
119
|
+
service account automatically. Code should be written as if already authenticated.
|
|
149
120
|
|
|
150
|
-
|
|
151
|
-
|
|
121
|
+
For more information, see
|
|
122
|
+
[Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
|
|
@@ -33,6 +33,9 @@ module Google
|
|
|
33
33
|
# public keys for logging into virtual machines on Google Cloud Platform.
|
|
34
34
|
#
|
|
35
35
|
class Client
|
|
36
|
+
# @private
|
|
37
|
+
DEFAULT_ENDPOINT_TEMPLATE = "oslogin.$UNIVERSE_DOMAIN$"
|
|
38
|
+
|
|
36
39
|
include Paths
|
|
37
40
|
|
|
38
41
|
# @private
|
|
@@ -123,6 +126,15 @@ module Google
|
|
|
123
126
|
@config
|
|
124
127
|
end
|
|
125
128
|
|
|
129
|
+
##
|
|
130
|
+
# The effective universe domain
|
|
131
|
+
#
|
|
132
|
+
# @return [String]
|
|
133
|
+
#
|
|
134
|
+
def universe_domain
|
|
135
|
+
@os_login_service_stub.universe_domain
|
|
136
|
+
end
|
|
137
|
+
|
|
126
138
|
##
|
|
127
139
|
# Create a new OsLoginService client object.
|
|
128
140
|
#
|
|
@@ -156,8 +168,9 @@ module Google
|
|
|
156
168
|
credentials = @config.credentials
|
|
157
169
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
158
170
|
# but only if the default endpoint does not have a region prefix.
|
|
159
|
-
enable_self_signed_jwt = @config.endpoint
|
|
160
|
-
|
|
171
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
172
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
173
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
161
174
|
credentials ||= Credentials.default scope: @config.scope,
|
|
162
175
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
163
176
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -168,8 +181,10 @@ module Google
|
|
|
168
181
|
|
|
169
182
|
@os_login_service_stub = ::Gapic::ServiceStub.new(
|
|
170
183
|
::Google::Cloud::OsLogin::V1::OsLoginService::Stub,
|
|
171
|
-
credentials:
|
|
172
|
-
endpoint:
|
|
184
|
+
credentials: credentials,
|
|
185
|
+
endpoint: @config.endpoint,
|
|
186
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
187
|
+
universe_domain: @config.universe_domain,
|
|
173
188
|
channel_args: @config.channel_args,
|
|
174
189
|
interceptors: @config.interceptors,
|
|
175
190
|
channel_pool_config: @config.channel_pool
|
|
@@ -631,7 +646,7 @@ module Google
|
|
|
631
646
|
# @param options [::Gapic::CallOptions, ::Hash]
|
|
632
647
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
633
648
|
#
|
|
634
|
-
# @overload import_ssh_public_key(parent: nil, ssh_public_key: nil, project_id: nil)
|
|
649
|
+
# @overload import_ssh_public_key(parent: nil, ssh_public_key: nil, project_id: nil, regions: nil)
|
|
635
650
|
# Pass arguments to `import_ssh_public_key` via keyword arguments. Note that at
|
|
636
651
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
637
652
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
@@ -642,6 +657,10 @@ module Google
|
|
|
642
657
|
# Optional. The SSH public key and expiration time.
|
|
643
658
|
# @param project_id [::String]
|
|
644
659
|
# The project ID of the Google Cloud Platform project.
|
|
660
|
+
# @param regions [::Array<::String>]
|
|
661
|
+
# Optional. The regions to which to assert that the key was written.
|
|
662
|
+
# If unspecified, defaults to all regions.
|
|
663
|
+
# Regions are listed at https://cloud.google.com/about/locations#region.
|
|
645
664
|
#
|
|
646
665
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
647
666
|
# @yieldparam response [::Google::Cloud::OsLogin::V1::ImportSshPublicKeyResponse]
|
|
@@ -829,9 +848,9 @@ module Google
|
|
|
829
848
|
# end
|
|
830
849
|
#
|
|
831
850
|
# @!attribute [rw] endpoint
|
|
832
|
-
#
|
|
833
|
-
#
|
|
834
|
-
# @return [::String]
|
|
851
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
852
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
853
|
+
# @return [::String,nil]
|
|
835
854
|
# @!attribute [rw] credentials
|
|
836
855
|
# Credentials to send with calls. You may provide any of the following types:
|
|
837
856
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -877,13 +896,20 @@ module Google
|
|
|
877
896
|
# @!attribute [rw] quota_project
|
|
878
897
|
# A separate project against which to charge quota.
|
|
879
898
|
# @return [::String]
|
|
899
|
+
# @!attribute [rw] universe_domain
|
|
900
|
+
# The universe domain within which to make requests. This determines the
|
|
901
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
902
|
+
# universe (usually the default "googleapis.com" universe).
|
|
903
|
+
# @return [::String,nil]
|
|
880
904
|
#
|
|
881
905
|
class Configuration
|
|
882
906
|
extend ::Gapic::Config
|
|
883
907
|
|
|
908
|
+
# @private
|
|
909
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
884
910
|
DEFAULT_ENDPOINT = "oslogin.googleapis.com"
|
|
885
911
|
|
|
886
|
-
config_attr :endpoint,
|
|
912
|
+
config_attr :endpoint, nil, ::String, nil
|
|
887
913
|
config_attr :credentials, nil do |value|
|
|
888
914
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
889
915
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -898,6 +924,7 @@ module Google
|
|
|
898
924
|
config_attr :metadata, nil, ::Hash, nil
|
|
899
925
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
900
926
|
config_attr :quota_project, nil, ::String, nil
|
|
927
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
901
928
|
|
|
902
929
|
# @private
|
|
903
930
|
def initialize parent_config = nil
|
|
@@ -35,6 +35,9 @@ module Google
|
|
|
35
35
|
# public keys for logging into virtual machines on Google Cloud Platform.
|
|
36
36
|
#
|
|
37
37
|
class Client
|
|
38
|
+
# @private
|
|
39
|
+
DEFAULT_ENDPOINT_TEMPLATE = "oslogin.$UNIVERSE_DOMAIN$"
|
|
40
|
+
|
|
38
41
|
include Paths
|
|
39
42
|
|
|
40
43
|
# @private
|
|
@@ -125,6 +128,15 @@ module Google
|
|
|
125
128
|
@config
|
|
126
129
|
end
|
|
127
130
|
|
|
131
|
+
##
|
|
132
|
+
# The effective universe domain
|
|
133
|
+
#
|
|
134
|
+
# @return [String]
|
|
135
|
+
#
|
|
136
|
+
def universe_domain
|
|
137
|
+
@os_login_service_stub.universe_domain
|
|
138
|
+
end
|
|
139
|
+
|
|
128
140
|
##
|
|
129
141
|
# Create a new OsLoginService REST client object.
|
|
130
142
|
#
|
|
@@ -152,8 +164,9 @@ module Google
|
|
|
152
164
|
credentials = @config.credentials
|
|
153
165
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
154
166
|
# but only if the default endpoint does not have a region prefix.
|
|
155
|
-
enable_self_signed_jwt = @config.endpoint
|
|
156
|
-
|
|
167
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
168
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
169
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
157
170
|
credentials ||= Credentials.default scope: @config.scope,
|
|
158
171
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
159
172
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -163,7 +176,12 @@ module Google
|
|
|
163
176
|
@quota_project_id = @config.quota_project
|
|
164
177
|
@quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
|
|
165
178
|
|
|
166
|
-
@os_login_service_stub = ::Google::Cloud::OsLogin::V1::OsLoginService::Rest::ServiceStub.new
|
|
179
|
+
@os_login_service_stub = ::Google::Cloud::OsLogin::V1::OsLoginService::Rest::ServiceStub.new(
|
|
180
|
+
endpoint: @config.endpoint,
|
|
181
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
182
|
+
universe_domain: @config.universe_domain,
|
|
183
|
+
credentials: credentials
|
|
184
|
+
)
|
|
167
185
|
end
|
|
168
186
|
|
|
169
187
|
# Service calls
|
|
@@ -586,7 +604,7 @@ module Google
|
|
|
586
604
|
# @param options [::Gapic::CallOptions, ::Hash]
|
|
587
605
|
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
|
588
606
|
#
|
|
589
|
-
# @overload import_ssh_public_key(parent: nil, ssh_public_key: nil, project_id: nil)
|
|
607
|
+
# @overload import_ssh_public_key(parent: nil, ssh_public_key: nil, project_id: nil, regions: nil)
|
|
590
608
|
# Pass arguments to `import_ssh_public_key` via keyword arguments. Note that at
|
|
591
609
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
592
610
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
@@ -597,6 +615,10 @@ module Google
|
|
|
597
615
|
# Optional. The SSH public key and expiration time.
|
|
598
616
|
# @param project_id [::String]
|
|
599
617
|
# The project ID of the Google Cloud Platform project.
|
|
618
|
+
# @param regions [::Array<::String>]
|
|
619
|
+
# Optional. The regions to which to assert that the key was written.
|
|
620
|
+
# If unspecified, defaults to all regions.
|
|
621
|
+
# Regions are listed at https://cloud.google.com/about/locations#region.
|
|
600
622
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
601
623
|
# @yieldparam result [::Google::Cloud::OsLogin::V1::ImportSshPublicKeyResponse]
|
|
602
624
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
@@ -770,9 +792,9 @@ module Google
|
|
|
770
792
|
# end
|
|
771
793
|
#
|
|
772
794
|
# @!attribute [rw] endpoint
|
|
773
|
-
#
|
|
774
|
-
#
|
|
775
|
-
# @return [::String]
|
|
795
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
796
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
797
|
+
# @return [::String,nil]
|
|
776
798
|
# @!attribute [rw] credentials
|
|
777
799
|
# Credentials to send with calls. You may provide any of the following types:
|
|
778
800
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -809,13 +831,20 @@ module Google
|
|
|
809
831
|
# @!attribute [rw] quota_project
|
|
810
832
|
# A separate project against which to charge quota.
|
|
811
833
|
# @return [::String]
|
|
834
|
+
# @!attribute [rw] universe_domain
|
|
835
|
+
# The universe domain within which to make requests. This determines the
|
|
836
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
837
|
+
# universe (usually the default "googleapis.com" universe).
|
|
838
|
+
# @return [::String,nil]
|
|
812
839
|
#
|
|
813
840
|
class Configuration
|
|
814
841
|
extend ::Gapic::Config
|
|
815
842
|
|
|
843
|
+
# @private
|
|
844
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
816
845
|
DEFAULT_ENDPOINT = "oslogin.googleapis.com"
|
|
817
846
|
|
|
818
|
-
config_attr :endpoint,
|
|
847
|
+
config_attr :endpoint, nil, ::String, nil
|
|
819
848
|
config_attr :credentials, nil do |value|
|
|
820
849
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
821
850
|
allowed.any? { |klass| klass === value }
|
|
@@ -827,6 +856,7 @@ module Google
|
|
|
827
856
|
config_attr :metadata, nil, ::Hash, nil
|
|
828
857
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
829
858
|
config_attr :quota_project, nil, ::String, nil
|
|
859
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
830
860
|
|
|
831
861
|
# @private
|
|
832
862
|
def initialize parent_config = nil
|
|
@@ -30,16 +30,28 @@ module Google
|
|
|
30
30
|
# including transcoding, making the REST call, and deserialing the response.
|
|
31
31
|
#
|
|
32
32
|
class ServiceStub
|
|
33
|
-
def initialize endpoint:, credentials:
|
|
33
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
|
34
34
|
# These require statements are intentionally placed here to initialize
|
|
35
35
|
# the REST modules only when it's required.
|
|
36
36
|
require "gapic/rest"
|
|
37
37
|
|
|
38
|
-
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
38
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
39
|
+
endpoint_template: endpoint_template,
|
|
40
|
+
universe_domain: universe_domain,
|
|
41
|
+
credentials: credentials,
|
|
39
42
|
numeric_enums: true,
|
|
40
43
|
raise_faraday_errors: false
|
|
41
44
|
end
|
|
42
45
|
|
|
46
|
+
##
|
|
47
|
+
# The effective universe domain
|
|
48
|
+
#
|
|
49
|
+
# @return [String]
|
|
50
|
+
#
|
|
51
|
+
def universe_domain
|
|
52
|
+
@client_stub.universe_domain
|
|
53
|
+
end
|
|
54
|
+
|
|
43
55
|
##
|
|
44
56
|
# Baseline implementation for the create_ssh_public_key REST call
|
|
45
57
|
#
|
|
@@ -13,7 +13,7 @@ require 'google/protobuf/empty_pb'
|
|
|
13
13
|
require 'google/protobuf/field_mask_pb'
|
|
14
14
|
|
|
15
15
|
|
|
16
|
-
descriptor_data = "\n%google/cloud/oslogin/v1/oslogin.proto\x12\x17google.cloud.oslogin.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a(google/cloud/oslogin/common/common.proto\x1a\x1bgoogle/protobuf/empty.proto\x1a google/protobuf/field_mask.proto\"\x98\x02\n\x0cLoginProfile\x12\x11\n\x04name\x18\x01 \x01(\tB\x03\xe0\x41\x02\x12\x41\n\x0eposix_accounts\x18\x02 \x03(\x0b\x32).google.cloud.oslogin.common.PosixAccount\x12Q\n\x0fssh_public_keys\x18\x03 \x03(\x0b\x32\x38.google.cloud.oslogin.v1.LoginProfile.SshPublicKeysEntry\x1a_\n\x12SshPublicKeysEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\x38\n\x05value\x18\x02 \x01(\x0b\x32).google.cloud.oslogin.common.SshPublicKey:\x02\x38\x01\"\xa0\x01\n\x19\x43reateSshPublicKeyRequest\x12;\n\x06parent\x18\x01 \x01(\tB+\xe0\x41\x02\xfa\x41%\x12#oslogin.googleapis.com/SshPublicKey\x12\x46\n\x0essh_public_key\x18\x02 \x01(\x0b\x32).google.cloud.oslogin.common.SshPublicKeyB\x03\xe0\x41\x02\"V\n\x19\x44\x65letePosixAccountRequest\x12\x39\n\x04name\x18\x01 \x01(\tB+\xe0\x41\x02\xfa\x41%\n#oslogin.googleapis.com/PosixAccount\"V\n\x19\x44\x65leteSshPublicKeyRequest\x12\x39\n\x04name\x18\x01 \x01(\tB+\xe0\x41\x02\xfa\x41%\n#oslogin.googleapis.com/SshPublicKey\"z\n\x16GetLoginProfileRequest\x12\x39\n\x04name\x18\x01 \x01(\tB+\xe0\x41\x02\xfa\x41%\x12#oslogin.googleapis.com/PosixAccount\x12\x12\n\nproject_id\x18\x02 \x01(\t\x12\x11\n\tsystem_id\x18\x03 \x01(\t\"S\n\x16GetSshPublicKeyRequest\x12\x39\n\x04name\x18\x01 \x01(\tB+\xe0\x41\x02\xfa\x41%\n#oslogin.googleapis.com/SshPublicKey\"\
|
|
16
|
+
descriptor_data = "\n%google/cloud/oslogin/v1/oslogin.proto\x12\x17google.cloud.oslogin.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a(google/cloud/oslogin/common/common.proto\x1a\x1bgoogle/protobuf/empty.proto\x1a google/protobuf/field_mask.proto\"\x98\x02\n\x0cLoginProfile\x12\x11\n\x04name\x18\x01 \x01(\tB\x03\xe0\x41\x02\x12\x41\n\x0eposix_accounts\x18\x02 \x03(\x0b\x32).google.cloud.oslogin.common.PosixAccount\x12Q\n\x0fssh_public_keys\x18\x03 \x03(\x0b\x32\x38.google.cloud.oslogin.v1.LoginProfile.SshPublicKeysEntry\x1a_\n\x12SshPublicKeysEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\x38\n\x05value\x18\x02 \x01(\x0b\x32).google.cloud.oslogin.common.SshPublicKey:\x02\x38\x01\"\xa0\x01\n\x19\x43reateSshPublicKeyRequest\x12;\n\x06parent\x18\x01 \x01(\tB+\xe0\x41\x02\xfa\x41%\x12#oslogin.googleapis.com/SshPublicKey\x12\x46\n\x0essh_public_key\x18\x02 \x01(\x0b\x32).google.cloud.oslogin.common.SshPublicKeyB\x03\xe0\x41\x02\"V\n\x19\x44\x65letePosixAccountRequest\x12\x39\n\x04name\x18\x01 \x01(\tB+\xe0\x41\x02\xfa\x41%\n#oslogin.googleapis.com/PosixAccount\"V\n\x19\x44\x65leteSshPublicKeyRequest\x12\x39\n\x04name\x18\x01 \x01(\tB+\xe0\x41\x02\xfa\x41%\n#oslogin.googleapis.com/SshPublicKey\"z\n\x16GetLoginProfileRequest\x12\x39\n\x04name\x18\x01 \x01(\tB+\xe0\x41\x02\xfa\x41%\x12#oslogin.googleapis.com/PosixAccount\x12\x12\n\nproject_id\x18\x02 \x01(\t\x12\x11\n\tsystem_id\x18\x03 \x01(\t\"S\n\x16GetSshPublicKeyRequest\x12\x39\n\x04name\x18\x01 \x01(\tB+\xe0\x41\x02\xfa\x41%\n#oslogin.googleapis.com/SshPublicKey\"\xca\x01\n\x19ImportSshPublicKeyRequest\x12;\n\x06parent\x18\x01 \x01(\tB+\xe0\x41\x02\xfa\x41%\x12#oslogin.googleapis.com/SshPublicKey\x12\x46\n\x0essh_public_key\x18\x02 \x01(\x0b\x32).google.cloud.oslogin.common.SshPublicKeyB\x03\xe0\x41\x01\x12\x12\n\nproject_id\x18\x03 \x01(\t\x12\x14\n\x07regions\x18\x05 \x03(\tB\x03\xe0\x41\x01\"k\n\x1aImportSshPublicKeyResponse\x12<\n\rlogin_profile\x18\x01 \x01(\x0b\x32%.google.cloud.oslogin.v1.LoginProfile\x12\x0f\n\x07\x64\x65tails\x18\x02 \x01(\t\"\xcf\x01\n\x19UpdateSshPublicKeyRequest\x12\x39\n\x04name\x18\x01 \x01(\tB+\xe0\x41\x02\xfa\x41%\n#oslogin.googleapis.com/SshPublicKey\x12\x46\n\x0essh_public_key\x18\x02 \x01(\x0b\x32).google.cloud.oslogin.common.SshPublicKeyB\x03\xe0\x41\x02\x12/\n\x0bupdate_mask\x18\x03 \x01(\x0b\x32\x1a.google.protobuf.FieldMask2\x86\x0c\n\x0eOsLoginService\x12\xc7\x01\n\x12\x43reateSshPublicKey\x12\x32.google.cloud.oslogin.v1.CreateSshPublicKeyRequest\x1a).google.cloud.oslogin.common.SshPublicKey\"R\x82\xd3\xe4\x93\x02\x34\"\"/v1/{parent=users/*}/sshPublicKeys:\x0essh_public_key\xda\x41\x15parent,ssh_public_key\x12\x8e\x01\n\x12\x44\x65letePosixAccount\x12\x32.google.cloud.oslogin.v1.DeletePosixAccountRequest\x1a\x16.google.protobuf.Empty\",\x82\xd3\xe4\x93\x02\x1f*\x1d/v1/{name=users/*/projects/*}\xda\x41\x04name\x12\x93\x01\n\x12\x44\x65leteSshPublicKey\x12\x32.google.cloud.oslogin.v1.DeleteSshPublicKeyRequest\x1a\x16.google.protobuf.Empty\"1\x82\xd3\xe4\x93\x02$*\"/v1/{name=users/*/sshPublicKeys/*}\xda\x41\x04name\x12\x99\x01\n\x0fGetLoginProfile\x12/.google.cloud.oslogin.v1.GetLoginProfileRequest\x1a%.google.cloud.oslogin.v1.LoginProfile\".\x82\xd3\xe4\x93\x02!\x12\x1f/v1/{name=users/*}/loginProfile\xda\x41\x04name\x12\xa0\x01\n\x0fGetSshPublicKey\x12/.google.cloud.oslogin.v1.GetSshPublicKeyRequest\x1a).google.cloud.oslogin.common.SshPublicKey\"1\x82\xd3\xe4\x93\x02$\x12\"/v1/{name=users/*/sshPublicKeys/*}\xda\x41\x04name\x12\xf9\x01\n\x12ImportSshPublicKey\x12\x32.google.cloud.oslogin.v1.ImportSshPublicKeyRequest\x1a\x33.google.cloud.oslogin.v1.ImportSshPublicKeyResponse\"z\x82\xd3\xe4\x93\x02\x39\"\'/v1/{parent=users/*}:importSshPublicKey:\x0essh_public_key\xda\x41\x15parent,ssh_public_key\xda\x41 parent,ssh_public_key,project_id\x12\xe7\x01\n\x12UpdateSshPublicKey\x12\x32.google.cloud.oslogin.v1.UpdateSshPublicKeyRequest\x1a).google.cloud.oslogin.common.SshPublicKey\"r\x82\xd3\xe4\x93\x02\x34\x32\"/v1/{name=users/*/sshPublicKeys/*}:\x0essh_public_key\xda\x41\x13name,ssh_public_key\xda\x41\x1fname,ssh_public_key,update_mask\x1a\xdd\x01\xca\x41\x16oslogin.googleapis.com\xd2\x41\xc0\x01https://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/cloud-platform.read-only,https://www.googleapis.com/auth/compute,https://www.googleapis.com/auth/compute.readonlyB\xb5\x01\n\x1b\x63om.google.cloud.oslogin.v1B\x0cOsLoginProtoP\x01Z5cloud.google.com/go/oslogin/apiv1/osloginpb;osloginpb\xaa\x02\x17Google.Cloud.OsLogin.V1\xca\x02\x17Google\\Cloud\\OsLogin\\V1\xea\x02\x1aGoogle::Cloud::OsLogin::V1b\x06proto3"
|
|
17
17
|
|
|
18
18
|
pool = Google::Protobuf::DescriptorPool.generated_pool
|
|
19
19
|
|
|
@@ -21,6 +21,7 @@ module Google
|
|
|
21
21
|
module Api
|
|
22
22
|
# Required information for every language.
|
|
23
23
|
# @!attribute [rw] reference_docs_uri
|
|
24
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
|
24
25
|
# @return [::String]
|
|
25
26
|
# Link to automatically generated reference documentation. Example:
|
|
26
27
|
# https://cloud.google.com/nodejs/docs/reference/asset/latest
|
|
@@ -304,6 +305,19 @@ module Google
|
|
|
304
305
|
# seconds: 360 # 6 minutes
|
|
305
306
|
# total_poll_timeout:
|
|
306
307
|
# seconds: 54000 # 90 minutes
|
|
308
|
+
# @!attribute [rw] auto_populated_fields
|
|
309
|
+
# @return [::Array<::String>]
|
|
310
|
+
# List of top-level fields of the request message, that should be
|
|
311
|
+
# automatically populated by the client libraries based on their
|
|
312
|
+
# (google.api.field_info).format. Currently supported format: UUID4.
|
|
313
|
+
#
|
|
314
|
+
# Example of a YAML configuration:
|
|
315
|
+
#
|
|
316
|
+
# publishing:
|
|
317
|
+
# method_settings:
|
|
318
|
+
# - selector: google.example.v1.ExampleService.CreateExample
|
|
319
|
+
# auto_populated_fields:
|
|
320
|
+
# - request_id
|
|
307
321
|
class MethodSettings
|
|
308
322
|
include ::Google::Protobuf::MessageExts
|
|
309
323
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -116,6 +116,11 @@ module Google
|
|
|
116
116
|
# @!attribute [rw] project_id
|
|
117
117
|
# @return [::String]
|
|
118
118
|
# The project ID of the Google Cloud Platform project.
|
|
119
|
+
# @!attribute [rw] regions
|
|
120
|
+
# @return [::Array<::String>]
|
|
121
|
+
# Optional. The regions to which to assert that the key was written.
|
|
122
|
+
# If unspecified, defaults to all regions.
|
|
123
|
+
# Regions are listed at https://cloud.google.com/about/locations#region.
|
|
119
124
|
class ImportSshPublicKeyRequest
|
|
120
125
|
include ::Google::Protobuf::MessageExts
|
|
121
126
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-cloud-os_login-v1
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.11.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Google LLC
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date:
|
|
11
|
+
date: 2024-01-11 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: gapic-common
|
|
@@ -16,7 +16,7 @@ dependencies:
|
|
|
16
16
|
requirements:
|
|
17
17
|
- - ">="
|
|
18
18
|
- !ruby/object:Gem::Version
|
|
19
|
-
version: 0.
|
|
19
|
+
version: 0.21.1
|
|
20
20
|
- - "<"
|
|
21
21
|
- !ruby/object:Gem::Version
|
|
22
22
|
version: 2.a
|
|
@@ -26,7 +26,7 @@ dependencies:
|
|
|
26
26
|
requirements:
|
|
27
27
|
- - ">="
|
|
28
28
|
- !ruby/object:Gem::Version
|
|
29
|
-
version: 0.
|
|
29
|
+
version: 0.21.1
|
|
30
30
|
- - "<"
|
|
31
31
|
- !ruby/object:Gem::Version
|
|
32
32
|
version: 2.a
|
|
@@ -214,7 +214,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
214
214
|
- !ruby/object:Gem::Version
|
|
215
215
|
version: '0'
|
|
216
216
|
requirements: []
|
|
217
|
-
rubygems_version: 3.
|
|
217
|
+
rubygems_version: 3.5.3
|
|
218
218
|
signing_key:
|
|
219
219
|
specification_version: 4
|
|
220
220
|
summary: You can use OS Login to manage access to your VM instances using IAM roles.
|