google-apis-sts_v1beta 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: a2f2aaac858819442bb1f774bd1bfc8fd476af13b1f2f86c244b82ad0eafbeb3
4
+ data.tar.gz: a86317e03fadebd26d01e9645e8fb8978a21fb4a2bdb515d61f3618d9e3b1091
5
+ SHA512:
6
+ metadata.gz: e54370746a14fdda22fff7f12440aa8a0b1f8dfadfa2c5e2549af58a11fbff5ecdbbf9c201c51ef0e2f8803404966596f5f9077f37453e51733be276068dbf23
7
+ data.tar.gz: ae6e98ef9e87b3f54bfcff3dc2d2b84a5d9f2e35c88d400d1ebc5ff13eb3b3774fab0a03dca2a477bfce3939f863c42c2dfe7f0532d2dd8fccdff4bdf21e044f
@@ -0,0 +1,13 @@
1
+ --hide-void-return
2
+ --no-private
3
+ --verbose
4
+ --title=google-apis-sts_v1beta
5
+ --markup-provider=redcarpet
6
+ --markup=markdown
7
+ --main OVERVIEW.md
8
+ lib/google/apis/sts_v1beta/*.rb
9
+ lib/google/apis/sts_v1beta.rb
10
+ -
11
+ OVERVIEW.md
12
+ CHANGELOG.md
13
+ LICENSE.md
@@ -0,0 +1,7 @@
1
+ # Release history for google-apis-sts_v1beta
2
+
3
+ ### v0.1.0 (2021-01-07)
4
+
5
+ * Regenerated using generator version 0.1.1
6
+ * Regenerated from discovery document revision 20201009
7
+
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -0,0 +1,96 @@
1
+ # Simple REST client for version V1beta of the Security Token Service API
2
+
3
+ This is a simple client library for version V1beta of the Security Token Service API. It provides:
4
+
5
+ * A client object that connects to the HTTP/JSON REST endpoint for the service.
6
+ * Ruby objects for data structures related to the service.
7
+ * Integration with the googleauth gem for authentication using OAuth, API keys, and service accounts.
8
+ * Control of retry, pagination, and timeouts.
9
+
10
+ Note that although this client library is supported and will continue to be updated to track changes to the service, it is otherwise considered complete and not under active development. Many Google services, especially Google Cloud Platform services, may provide a more modern client that is under more active development and improvement. See the section below titled *Which client should I use?* for more information.
11
+
12
+ ## Getting started
13
+
14
+ ### Before you begin
15
+
16
+ There are a few setup steps you need to complete before you can use this library:
17
+
18
+ 1. If you don't already have a Google account, [sign up](https://www.google.com/accounts).
19
+ 2. If you have never created a Google APIs Console project, read about [Managing Projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects) and create a project in the [Google API Console](https://console.cloud.google.com/).
20
+ 3. Most APIs need to be enabled for your project. [Enable it](https://console.cloud.google.com/apis/library/sts.googleapis.com) in the console.
21
+
22
+ ### Installation
23
+
24
+ Add this line to your application's Gemfile:
25
+
26
+ ```ruby
27
+ gem 'google-apis-sts_v1beta', '~> 0.1'
28
+ ```
29
+
30
+ And then execute:
31
+
32
+ ```
33
+ $ bundle
34
+ ```
35
+
36
+ Or install it yourself as:
37
+
38
+ ```
39
+ $ gem install google-apis-sts_v1beta
40
+ ```
41
+
42
+ ### Creating a client object
43
+
44
+ Once the gem is installed, you can load the client code and instantiate a client.
45
+
46
+ ```ruby
47
+ # Load the client
48
+ require "google/apis/sts_v1beta"
49
+
50
+ # Create a client object
51
+ client = Google::Apis::StsV1beta::CloudSecurityTokenService.new
52
+
53
+ # Authenticate calls
54
+ client.authentication = # ... use the googleauth gem to create credentials
55
+ ```
56
+
57
+ See the class reference docs for information on the methods you can call from a client.
58
+
59
+ ## Documentation
60
+
61
+ More detailed descriptions of the Google simple REST clients are available in two documents.
62
+
63
+ * The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
64
+ * The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.
65
+
66
+ (Note: the above documents are written for the simple REST clients in general, and their examples may not reflect the Sts service in particular.)
67
+
68
+ For reference information on specific calls in the Security Token Service API, see the {Google::Apis::StsV1beta::CloudSecurityTokenService class reference docs}.
69
+
70
+ ## Which client should I use?
71
+
72
+ Google provides two types of Ruby API client libraries: **simple REST clients** and **modern clients**.
73
+
74
+ This library, `google-apis-sts_v1beta`, is a simple REST client. You can identify these clients by their gem names, which are always in the form `google-apis-<servicename>_<serviceversion>`. The simple REST clients connect to HTTP/JSON REST endpoints and are automatically generated from service discovery documents. They support most API functionality, but their class interfaces are sometimes awkward.
75
+
76
+ Modern clients are produced by a modern code generator, sometimes combined with hand-crafted functionality. Most modern clients connect to high-performance gRPC endpoints, although a few are backed by REST services. Modern clients are available for many Google services, especially Google Cloud Platform services, but do not yet support all the services covered by the simple clients.
77
+
78
+ Gem names for modern clients are often of the form `google-cloud-<service_name>`. (For example, [google-cloud-pubsub](https://rubygems.org/gems/google-cloud-pubsub).) Note that most modern clients also have corresponding "versioned" gems with names like `google-cloud-<service_name>-<version>`. (For example, [google-cloud-pubsub-v1](https://rubygems.org/gems/google-cloud-pubsub-v1).) The "versioned" gems can be used directly, but often provide lower-level interfaces. In most cases, the main gem is recommended.
79
+
80
+ **For most users, we recommend the modern client, if one is available.** Compared with simple clients, modern clients are generally much easier to use and more Ruby-like, support more advanced features such as streaming and long-running operations, and often provide much better performance. You may consider using a simple client instead, if a modern client is not yet available for the service you want to use, or if you are not able to use gRPC on your infrastructure.
81
+
82
+ The [product documentation](http://cloud.google.com/iam/docs/workload-identity-federation) may provide guidance regarding the preferred client library to use.
83
+
84
+ ## Supported Ruby versions
85
+
86
+ This library is supported on Ruby 2.5+.
87
+
88
+ Google provides official support for Ruby versions that are actively supported by Ruby Core -- that is, Ruby versions that are either in normal maintenance or in security maintenance, and not end of life. Currently, this means Ruby 2.5 and later. Older versions of Ruby _may_ still work, but are unsupported and not recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby support schedule.
89
+
90
+ ## License
91
+
92
+ This library is licensed under Apache 2.0. Full license text is available in the {file:LICENSE.md LICENSE}.
93
+
94
+ ## Support
95
+
96
+ Please [report bugs at the project on Github](https://github.com/google/google-api-ruby-client/issues). Don't hesitate to [ask questions](http://stackoverflow.com/questions/tagged/google-api-ruby-client) about the client or APIs on [StackOverflow](http://stackoverflow.com).
@@ -0,0 +1,15 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require "google/apis/sts_v1beta"
@@ -0,0 +1,34 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'google/apis/sts_v1beta/service.rb'
16
+ require 'google/apis/sts_v1beta/classes.rb'
17
+ require 'google/apis/sts_v1beta/representations.rb'
18
+ require 'google/apis/sts_v1beta/gem_version.rb'
19
+
20
+ module Google
21
+ module Apis
22
+ # Security Token Service API
23
+ #
24
+ # The Security Token Service exchanges Google or third-party credentials for a
25
+ # short-lived access token to Google Cloud resources.
26
+ #
27
+ # @see http://cloud.google.com/iam/docs/workload-identity-federation
28
+ module StsV1beta
29
+ # Version of the Security Token Service API this client connects to.
30
+ # This is NOT the gem version.
31
+ VERSION = 'V1beta'
32
+ end
33
+ end
34
+ end
@@ -0,0 +1,191 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'date'
16
+ require 'google/apis/core/base_service'
17
+ require 'google/apis/core/json_representation'
18
+ require 'google/apis/core/hashable'
19
+ require 'google/apis/errors'
20
+
21
+ module Google
22
+ module Apis
23
+ module StsV1beta
24
+
25
+ # Request message for ExchangeToken.
26
+ class GoogleIdentityStsV1betaExchangeTokenRequest
27
+ include Google::Apis::Core::Hashable
28
+
29
+ # The full resource name of the identity provider. For example, `//iam.
30
+ # googleapis.com/projects//workloadIdentityPools//providers/`. Required when
31
+ # exchanging an external credential for a Google access token.
32
+ # Corresponds to the JSON property `audience`
33
+ # @return [String]
34
+ attr_accessor :audience
35
+
36
+ # Required. The grant type. Must be `urn:ietf:params:oauth:grant-type:token-
37
+ # exchange`, which indicates a token exchange.
38
+ # Corresponds to the JSON property `grantType`
39
+ # @return [String]
40
+ attr_accessor :grant_type
41
+
42
+ # A set of features that Security Token Service supports, in addition to the
43
+ # standard OAuth 2.0 token exchange, formatted as a serialized JSON object of
44
+ # Options.
45
+ # Corresponds to the JSON property `options`
46
+ # @return [String]
47
+ attr_accessor :options
48
+
49
+ # Required. The type of security token. Must be `urn:ietf:params:oauth:token-
50
+ # type:access_token`, which indicates an OAuth 2.0 access token.
51
+ # Corresponds to the JSON property `requestedTokenType`
52
+ # @return [String]
53
+ attr_accessor :requested_token_type
54
+
55
+ # The OAuth 2.0 scopes to include on the resulting access token, formatted as a
56
+ # list of space-delimited, case-sensitive strings. Required when exchanging an
57
+ # external credential for a Google access token.
58
+ # Corresponds to the JSON property `scope`
59
+ # @return [String]
60
+ attr_accessor :scope
61
+
62
+ # Required. The input token. This token is a either an external credential
63
+ # issued by a workload identity pool provider, or a short-lived access token
64
+ # issued by Google. If the token is an OIDC JWT, it must use the JWT format
65
+ # defined in [RFC 7523](https://tools.ietf.org/html/rfc7523), and the `
66
+ # subject_token_type` must be `urn:ietf:params:oauth:token-type:jwt`. The
67
+ # following headers are required: - `kid`: The identifier of the signing key
68
+ # securing the JWT. - `alg`: The cryptographic algorithm securing the JWT. Must
69
+ # be `RS256`. The following payload fields are required. For more information,
70
+ # see [RFC 7523, Section 3](https://tools.ietf.org/html/rfc7523#section-3): - `
71
+ # iss`: The issuer of the token. The issuer must provide a discovery document at
72
+ # the URL `/.well-known/openid-configuration`, where `` is the value of this
73
+ # field. The document must be formatted according to section 4.2 of the [OIDC 1.
74
+ # 0 Discovery specification](https://openid.net/specs/openid-connect-discovery-
75
+ # 1_0.html#ProviderConfigurationResponse). - `iat`: The issue time, in seconds,
76
+ # since the Unix epoch. Must be in the past. - `exp`: The expiration time, in
77
+ # seconds, since the Unix epoch. Must be less than 48 hours after `iat`. Shorter
78
+ # expiration times are more secure. If possible, we recommend setting an
79
+ # expiration time less than 6 hours. - `sub`: The identity asserted in the JWT. -
80
+ # `aud`: Configured by the mapper policy. The default value is the service
81
+ # account's unique ID. Example header: ``` ` "alg": "RS256", "kid": "us-east-11"
82
+ # ` ``` Example payload: ``` ` "iss": "https://accounts.google.com", "iat":
83
+ # 1517963104, "exp": 1517966704, "aud": "113475438248934895348", "sub": "
84
+ # 113475438248934895348", "my_claims": ` "additional_claim": "value" ` ` ``` If `
85
+ # subject_token` is an AWS token, it must be a serialized, [signed](https://docs.
86
+ # aws.amazon.com/general/latest/gr/signing_aws_api_requests.html) request to the
87
+ # AWS [`GetCallerIdentity()`](https://docs.aws.amazon.com/STS/latest/
88
+ # APIReference/API_GetCallerIdentity) method. Format the request as URL-encoded
89
+ # JSON, and set the `subject_token_type` parameter to `urn:ietf:params:aws:token-
90
+ # type:aws4_request`. The following parameters are required: - `url`: The URL of
91
+ # the AWS STS endpoint for `GetCallerIdentity()`, such as `https://sts.amazonaws.
92
+ # com?Action=GetCallerIdentity&Version=2011-06-15`. Regional endpoints are also
93
+ # supported. - `method`: The HTTP request method: `POST`. - `headers`: The HTTP
94
+ # request headers, which must include: - `Authorization`: The request signature.
95
+ # - `x-amz-date`: The time you will send the request, formatted as an [ISO8601
96
+ # Basic](https://docs.aws.amazon.com/general/latest/gr/sigv4_elements.html#
97
+ # sigv4_elements_date) string. This is typically set to the current time and
98
+ # used to prevent replay attacks. - `host`: The hostname of the `url` field; for
99
+ # example, `sts.amazonaws.com`. - `x-goog-cloud-target-resource`: The full,
100
+ # canonical resource name of the workload identity pool provider, with or
101
+ # without an `https:` prefix. To help ensure data integrity, we recommend
102
+ # including this header in the `SignedHeaders` field of the signed request. For
103
+ # example: //iam.googleapis.com/projects//locations//workloadIdentityPools//
104
+ # providers/ https://iam.googleapis.com/projects//locations//
105
+ # workloadIdentityPools//providers/ If you are using temporary security
106
+ # credentials provided by AWS, you must also include the header `x-amz-security-
107
+ # token`, with the value ``. The following example shows a signed, serialized
108
+ # request: ``` ` "headers":[ `"key": "x-amz-date", "value": "20200815T015049Z"`,
109
+ # `"key": "Authorization", "value": "AWS4-HMAC-SHA256+Credential=$credential,+
110
+ # SignedHeaders=host;x-amz-date;x-goog-cloud-target-resource,+Signature=$
111
+ # signature"`, `"key": "x-goog-cloud-target-resource", "value": "//iam.
112
+ # googleapis.com/projects//locations//workloadIdentityPools//providers/"`, `"key"
113
+ # : "host", "value": "sts.amazonaws.com"` . ], "method":"POST", "url":"https://
114
+ # sts.amazonaws.com?Action=GetCallerIdentity&Version=2011-06-15" ` ``` You can
115
+ # also use a Google-issued OAuth 2.0 access token with this field to obtain an
116
+ # access token with new security attributes applied, such as a Credential Access
117
+ # Boundary. In this case, set `subject_token_type` to `urn:ietf:params:oauth:
118
+ # token-type:access_token`. If an access token already contains security
119
+ # attributes, you cannot apply additional security attributes.
120
+ # Corresponds to the JSON property `subjectToken`
121
+ # @return [String]
122
+ attr_accessor :subject_token
123
+
124
+ # Required. `urn:ietf:params:oauth:token-type:access_token`.
125
+ # Corresponds to the JSON property `subjectTokenType`
126
+ # @return [String]
127
+ attr_accessor :subject_token_type
128
+
129
+ def initialize(**args)
130
+ update!(**args)
131
+ end
132
+
133
+ # Update properties of this object
134
+ def update!(**args)
135
+ @audience = args[:audience] if args.key?(:audience)
136
+ @grant_type = args[:grant_type] if args.key?(:grant_type)
137
+ @options = args[:options] if args.key?(:options)
138
+ @requested_token_type = args[:requested_token_type] if args.key?(:requested_token_type)
139
+ @scope = args[:scope] if args.key?(:scope)
140
+ @subject_token = args[:subject_token] if args.key?(:subject_token)
141
+ @subject_token_type = args[:subject_token_type] if args.key?(:subject_token_type)
142
+ end
143
+ end
144
+
145
+ # Response message for ExchangeToken.
146
+ class GoogleIdentityStsV1betaExchangeTokenResponse
147
+ include Google::Apis::Core::Hashable
148
+
149
+ # An OAuth 2.0 security token, issued by Google, in response to the token
150
+ # exchange request. Tokens can vary in size, depending in part on the size of
151
+ # mapped claims, up to a maximum of 12288 bytes (12 KB). Google reserves the
152
+ # right to change the token size and the maximum length at any time.
153
+ # Corresponds to the JSON property `access_token`
154
+ # @return [String]
155
+ attr_accessor :access_token
156
+
157
+ # The amount of time, in seconds, between the time when the `access_token` was
158
+ # issued and the time when the `access_token` will expire. This field is absent
159
+ # when the `subject_token` in the request is a Google-issued, short-lived access
160
+ # token. In this case, the `access_token` has the same expiration time as the `
161
+ # subject_token`.
162
+ # Corresponds to the JSON property `expires_in`
163
+ # @return [Fixnum]
164
+ attr_accessor :expires_in
165
+
166
+ # The token type. Always matches the value of `requested_token_type` from the
167
+ # request.
168
+ # Corresponds to the JSON property `issued_token_type`
169
+ # @return [String]
170
+ attr_accessor :issued_token_type
171
+
172
+ # The type of `access_token`. Always has the value `Bearer`.
173
+ # Corresponds to the JSON property `token_type`
174
+ # @return [String]
175
+ attr_accessor :token_type
176
+
177
+ def initialize(**args)
178
+ update!(**args)
179
+ end
180
+
181
+ # Update properties of this object
182
+ def update!(**args)
183
+ @access_token = args[:access_token] if args.key?(:access_token)
184
+ @expires_in = args[:expires_in] if args.key?(:expires_in)
185
+ @issued_token_type = args[:issued_token_type] if args.key?(:issued_token_type)
186
+ @token_type = args[:token_type] if args.key?(:token_type)
187
+ end
188
+ end
189
+ end
190
+ end
191
+ end
@@ -0,0 +1,28 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ module Google
16
+ module Apis
17
+ module StsV1beta
18
+ # Version of the google-apis-sts_v1beta gem
19
+ GEM_VERSION = "0.1.0"
20
+
21
+ # Version of the code generator used to generate this client
22
+ GENERATOR_VERSION = "0.1.1"
23
+
24
+ # Revision of the discovery document this client was generated from
25
+ REVISION = "20201009"
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,61 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'date'
16
+ require 'google/apis/core/base_service'
17
+ require 'google/apis/core/json_representation'
18
+ require 'google/apis/core/hashable'
19
+ require 'google/apis/errors'
20
+
21
+ module Google
22
+ module Apis
23
+ module StsV1beta
24
+
25
+ class GoogleIdentityStsV1betaExchangeTokenRequest
26
+ class Representation < Google::Apis::Core::JsonRepresentation; end
27
+
28
+ include Google::Apis::Core::JsonObjectSupport
29
+ end
30
+
31
+ class GoogleIdentityStsV1betaExchangeTokenResponse
32
+ class Representation < Google::Apis::Core::JsonRepresentation; end
33
+
34
+ include Google::Apis::Core::JsonObjectSupport
35
+ end
36
+
37
+ class GoogleIdentityStsV1betaExchangeTokenRequest
38
+ # @private
39
+ class Representation < Google::Apis::Core::JsonRepresentation
40
+ property :audience, as: 'audience'
41
+ property :grant_type, as: 'grantType'
42
+ property :options, as: 'options'
43
+ property :requested_token_type, as: 'requestedTokenType'
44
+ property :scope, as: 'scope'
45
+ property :subject_token, as: 'subjectToken'
46
+ property :subject_token_type, as: 'subjectTokenType'
47
+ end
48
+ end
49
+
50
+ class GoogleIdentityStsV1betaExchangeTokenResponse
51
+ # @private
52
+ class Representation < Google::Apis::Core::JsonRepresentation
53
+ property :access_token, as: 'access_token'
54
+ property :expires_in, as: 'expires_in'
55
+ property :issued_token_type, as: 'issued_token_type'
56
+ property :token_type, as: 'token_type'
57
+ end
58
+ end
59
+ end
60
+ end
61
+ end
@@ -0,0 +1,94 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'google/apis/core/base_service'
16
+ require 'google/apis/core/json_representation'
17
+ require 'google/apis/core/hashable'
18
+ require 'google/apis/errors'
19
+
20
+ module Google
21
+ module Apis
22
+ module StsV1beta
23
+ # Security Token Service API
24
+ #
25
+ # The Security Token Service exchanges Google or third-party credentials for a
26
+ # short-lived access token to Google Cloud resources.
27
+ #
28
+ # @example
29
+ # require 'google/apis/sts_v1beta'
30
+ #
31
+ # Sts = Google::Apis::StsV1beta # Alias the module
32
+ # service = Sts::CloudSecurityTokenService.new
33
+ #
34
+ # @see http://cloud.google.com/iam/docs/workload-identity-federation
35
+ class CloudSecurityTokenService < Google::Apis::Core::BaseService
36
+ # @return [String]
37
+ # API key. Your API key identifies your project and provides you with API access,
38
+ # quota, and reports. Required unless you provide an OAuth 2.0 token.
39
+ attr_accessor :key
40
+
41
+ # @return [String]
42
+ # Available to use for quota purposes for server-side applications. Can be any
43
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
44
+ attr_accessor :quota_user
45
+
46
+ def initialize
47
+ super('https://sts.googleapis.com/', '',
48
+ client_name: 'google-apis-sts_v1beta',
49
+ client_version: Google::Apis::StsV1beta::GEM_VERSION)
50
+ @batch_path = 'batch'
51
+ end
52
+
53
+ # Exchanges a credential for a Google OAuth 2.0 access token. The token asserts
54
+ # an external identity within a workload identity pool, or it applies a
55
+ # Credential Access Boundary to a Google access token.
56
+ # @param [Google::Apis::StsV1beta::GoogleIdentityStsV1betaExchangeTokenRequest] google_identity_sts_v1beta_exchange_token_request_object
57
+ # @param [String] fields
58
+ # Selector specifying which fields to include in a partial response.
59
+ # @param [String] quota_user
60
+ # Available to use for quota purposes for server-side applications. Can be any
61
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
62
+ # @param [Google::Apis::RequestOptions] options
63
+ # Request-specific options
64
+ #
65
+ # @yield [result, err] Result & error if block supplied
66
+ # @yieldparam result [Google::Apis::StsV1beta::GoogleIdentityStsV1betaExchangeTokenResponse] parsed result object
67
+ # @yieldparam err [StandardError] error object if request failed
68
+ #
69
+ # @return [Google::Apis::StsV1beta::GoogleIdentityStsV1betaExchangeTokenResponse]
70
+ #
71
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
72
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
73
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
74
+ def token(google_identity_sts_v1beta_exchange_token_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
75
+ command = make_simple_command(:post, 'v1beta/token', options)
76
+ command.request_representation = Google::Apis::StsV1beta::GoogleIdentityStsV1betaExchangeTokenRequest::Representation
77
+ command.request_object = google_identity_sts_v1beta_exchange_token_request_object
78
+ command.response_representation = Google::Apis::StsV1beta::GoogleIdentityStsV1betaExchangeTokenResponse::Representation
79
+ command.response_class = Google::Apis::StsV1beta::GoogleIdentityStsV1betaExchangeTokenResponse
80
+ command.query['fields'] = fields unless fields.nil?
81
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
82
+ execute_or_queue_command(command, &block)
83
+ end
84
+
85
+ protected
86
+
87
+ def apply_command_defaults(command)
88
+ command.query['key'] = key unless key.nil?
89
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
90
+ end
91
+ end
92
+ end
93
+ end
94
+ end
metadata ADDED
@@ -0,0 +1,76 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: google-apis-sts_v1beta
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Google LLC
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2021-01-08 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: google-apis-core
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '0.1'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '0.1'
27
+ description: This is the simple REST client for Security Token Service API V1beta.
28
+ Simple REST clients are Ruby client libraries that provide access to Google services
29
+ via their HTTP REST API endpoints. These libraries are generated and updated automatically
30
+ based on the discovery documents published by the service, and they handle most
31
+ concerns such as authentication, pagination, retry, timeouts, and logging. You can
32
+ use this client to access the Security Token Service API, but note that some services
33
+ may provide a separate modern client that is easier to use.
34
+ email: googleapis-packages@google.com
35
+ executables: []
36
+ extensions: []
37
+ extra_rdoc_files: []
38
+ files:
39
+ - ".yardopts"
40
+ - CHANGELOG.md
41
+ - LICENSE.md
42
+ - OVERVIEW.md
43
+ - lib/google-apis-sts_v1beta.rb
44
+ - lib/google/apis/sts_v1beta.rb
45
+ - lib/google/apis/sts_v1beta/classes.rb
46
+ - lib/google/apis/sts_v1beta/gem_version.rb
47
+ - lib/google/apis/sts_v1beta/representations.rb
48
+ - lib/google/apis/sts_v1beta/service.rb
49
+ homepage: https://github.com/google/google-api-ruby-client
50
+ licenses:
51
+ - Apache-2.0
52
+ metadata:
53
+ bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
54
+ changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-sts_v1beta/CHANGELOG.md
55
+ documentation_uri: https://googleapis.dev/ruby/google-apis-sts_v1beta/v0.1.0
56
+ source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-sts_v1beta
57
+ post_install_message:
58
+ rdoc_options: []
59
+ require_paths:
60
+ - lib
61
+ required_ruby_version: !ruby/object:Gem::Requirement
62
+ requirements:
63
+ - - ">="
64
+ - !ruby/object:Gem::Version
65
+ version: '2.4'
66
+ required_rubygems_version: !ruby/object:Gem::Requirement
67
+ requirements:
68
+ - - ">="
69
+ - !ruby/object:Gem::Version
70
+ version: '0'
71
+ requirements: []
72
+ rubygems_version: 3.1.4
73
+ signing_key:
74
+ specification_version: 4
75
+ summary: Simple REST client for Security Token Service API V1beta
76
+ test_files: []