Skip to content

Commit 88ebba5

Browse files
yoshi-automationyoshi-automation
committed
feat(iam): update the api
#### iam:v1 The following keys were added: - resources.projects.resources.serviceAccounts.resources.keys.methods.disable (Total Keys: 12) - resources.projects.resources.serviceAccounts.resources.keys.methods.enable (Total Keys: 12) - schemas.DisableServiceAccountKeyRequest (Total Keys: 2) - schemas.EnableServiceAccountKeyRequest (Total Keys: 2) - schemas.ServiceAccountKey.properties.disabled.type (Total Keys: 1)
1 parent 04e2c40 commit 88ebba5

File tree

2 files changed

+131
-1
lines changed

2 files changed

+131
-1
lines changed

‎docs/dyn/iam_v1.projects.serviceAccounts.keys.html

+58
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,12 @@ <h2>Instance Methods</h2>
8383
<p class="toc_element">
8484
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
8585
<p class="firstline">Deletes a ServiceAccountKey. Deleting a service account key does not revoke short-lived credentials that have been issued based on the service account key.</p>
86+
<p class="toc_element">
87+
<code><a href="#disable">disable(name, body=None, x__xgafv=None)</a></code></p>
88+
<p class="firstline">Disable a ServiceAccountKey. A disabled service account key can be enabled through EnableServiceAccountKey. The API is currently in preview phase.</p>
89+
<p class="toc_element">
90+
<code><a href="#enable">enable(name, body=None, x__xgafv=None)</a></code></p>
91+
<p class="firstline">Enable a ServiceAccountKey. The API is currently in preview phase.</p>
8692
<p class="toc_element">
8793
<code><a href="#get">get(name, publicKeyType=None, x__xgafv=None)</a></code></p>
8894
<p class="firstline">Gets a ServiceAccountKey.</p>
@@ -121,6 +127,7 @@ <h3>Method Details</h3>
121127
An object of the form:
122128

123129
{ # Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key&#x27;s lifetime. If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing. Public keys for all service accounts are also published at the OAuth2 Service Account API.
130+
&quot;disabled&quot;: True or False, # The key status.
124131
&quot;keyAlgorithm&quot;: &quot;A String&quot;, # Specifies the algorithm (and possibly key size) for the key.
125132
&quot;keyOrigin&quot;: &quot;A String&quot;, # The key origin.
126133
&quot;keyType&quot;: &quot;A String&quot;, # The key type.
@@ -151,6 +158,54 @@ <h3>Method Details</h3>
151158
}</pre>
152159
</div>
153160

161+
<div class="method">
162+
<code class="details" id="disable">disable(name, body=None, x__xgafv=None)</code>
163+
<pre>Disable a ServiceAccountKey. A disabled service account key can be enabled through EnableServiceAccountKey. The API is currently in preview phase.
164+
165+
Args:
166+
name: string, Required. The resource name of the service account key in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. (required)
167+
body: object, The request body.
168+
The object takes the form of:
169+
170+
{ # The service account key disable request.
171+
}
172+
173+
x__xgafv: string, V1 error format.
174+
Allowed values
175+
1 - v1 error format
176+
2 - v2 error format
177+
178+
Returns:
179+
An object of the form:
180+
181+
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
182+
}</pre>
183+
</div>
184+
185+
<div class="method">
186+
<code class="details" id="enable">enable(name, body=None, x__xgafv=None)</code>
187+
<pre>Enable a ServiceAccountKey. The API is currently in preview phase.
188+
189+
Args:
190+
name: string, Required. The resource name of the service account key in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. (required)
191+
body: object, The request body.
192+
The object takes the form of:
193+
194+
{ # The service account key enable request.
195+
}
196+
197+
x__xgafv: string, V1 error format.
198+
Allowed values
199+
1 - v1 error format
200+
2 - v2 error format
201+
202+
Returns:
203+
An object of the form:
204+
205+
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
206+
}</pre>
207+
</div>
208+
154209
<div class="method">
155210
<code class="details" id="get">get(name, publicKeyType=None, x__xgafv=None)</code>
156211
<pre>Gets a ServiceAccountKey.
@@ -171,6 +226,7 @@ <h3>Method Details</h3>
171226
An object of the form:
172227

173228
{ # Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key&#x27;s lifetime. If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing. Public keys for all service accounts are also published at the OAuth2 Service Account API.
229+
&quot;disabled&quot;: True or False, # The key status.
174230
&quot;keyAlgorithm&quot;: &quot;A String&quot;, # Specifies the algorithm (and possibly key size) for the key.
175231
&quot;keyOrigin&quot;: &quot;A String&quot;, # The key origin.
176232
&quot;keyType&quot;: &quot;A String&quot;, # The key type.
@@ -205,6 +261,7 @@ <h3>Method Details</h3>
205261
{ # The service account keys list response.
206262
&quot;keys&quot;: [ # The public keys for the service account.
207263
{ # Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key&#x27;s lifetime. If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing. Public keys for all service accounts are also published at the OAuth2 Service Account API.
264+
&quot;disabled&quot;: True or False, # The key status.
208265
&quot;keyAlgorithm&quot;: &quot;A String&quot;, # Specifies the algorithm (and possibly key size) for the key.
209266
&quot;keyOrigin&quot;: &quot;A String&quot;, # The key origin.
210267
&quot;keyType&quot;: &quot;A String&quot;, # The key type.
@@ -241,6 +298,7 @@ <h3>Method Details</h3>
241298
An object of the form:
242299

243300
{ # Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key&#x27;s lifetime. If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing. Public keys for all service accounts are also published at the OAuth2 Service Account API.
301+
&quot;disabled&quot;: True or False, # The key status.
244302
&quot;keyAlgorithm&quot;: &quot;A String&quot;, # Specifies the algorithm (and possibly key size) for the key.
245303
&quot;keyOrigin&quot;: &quot;A String&quot;, # The key origin.
246304
&quot;keyType&quot;: &quot;A String&quot;, # The key type.

‎googleapiclient/discovery_cache/documents/iam.v1.json

+73-1
Original file line numberDiff line numberDiff line change
@@ -1483,6 +1483,62 @@
14831483
"https://www.googleapis.com/auth/cloud-platform"
14841484
]
14851485
},
1486+
"disable": {
1487+
"description": "Disable a ServiceAccountKey. A disabled service account key can be enabled through EnableServiceAccountKey. The API is currently in preview phase.",
1488+
"flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys/{keysId}:disable",
1489+
"httpMethod": "POST",
1490+
"id": "iam.projects.serviceAccounts.keys.disable",
1491+
"parameterOrder": [
1492+
"name"
1493+
],
1494+
"parameters": {
1495+
"name": {
1496+
"description": "Required. The resource name of the service account key in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account.",
1497+
"location": "path",
1498+
"pattern": "^projects/[^/]+/serviceAccounts/[^/]+/keys/[^/]+$",
1499+
"required": true,
1500+
"type": "string"
1501+
}
1502+
},
1503+
"path": "v1/{+name}:disable",
1504+
"request": {
1505+
"$ref": "DisableServiceAccountKeyRequest"
1506+
},
1507+
"response": {
1508+
"$ref": "Empty"
1509+
},
1510+
"scopes": [
1511+
"https://www.googleapis.com/auth/cloud-platform"
1512+
]
1513+
},
1514+
"enable": {
1515+
"description": "Enable a ServiceAccountKey. The API is currently in preview phase.",
1516+
"flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys/{keysId}:enable",
1517+
"httpMethod": "POST",
1518+
"id": "iam.projects.serviceAccounts.keys.enable",
1519+
"parameterOrder": [
1520+
"name"
1521+
],
1522+
"parameters": {
1523+
"name": {
1524+
"description": "Required. The resource name of the service account key in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account.",
1525+
"location": "path",
1526+
"pattern": "^projects/[^/]+/serviceAccounts/[^/]+/keys/[^/]+$",
1527+
"required": true,
1528+
"type": "string"
1529+
}
1530+
},
1531+
"path": "v1/{+name}:enable",
1532+
"request": {
1533+
"$ref": "EnableServiceAccountKeyRequest"
1534+
},
1535+
"response": {
1536+
"$ref": "Empty"
1537+
},
1538+
"scopes": [
1539+
"https://www.googleapis.com/auth/cloud-platform"
1540+
]
1541+
},
14861542
"get": {
14871543
"description": "Gets a ServiceAccountKey.",
14881544
"flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys/{keysId}",
@@ -1696,7 +1752,7 @@
16961752
}
16971753
}
16981754
},
1699-
"revision": "20210812",
1755+
"revision": "20210825",
17001756
"rootUrl": "https://iam.googleapis.com/",
17011757
"schemas": {
17021758
"AdminAuditData": {
@@ -1911,6 +1967,12 @@
19111967
},
19121968
"type": "object"
19131969
},
1970+
"DisableServiceAccountKeyRequest": {
1971+
"description": "The service account key disable request.",
1972+
"id": "DisableServiceAccountKeyRequest",
1973+
"properties": {},
1974+
"type": "object"
1975+
},
19141976
"DisableServiceAccountRequest": {
19151977
"description": "The service account disable request.",
19161978
"id": "DisableServiceAccountRequest",
@@ -1923,6 +1985,12 @@
19231985
"properties": {},
19241986
"type": "object"
19251987
},
1988+
"EnableServiceAccountKeyRequest": {
1989+
"description": "The service account key enable request.",
1990+
"id": "EnableServiceAccountKeyRequest",
1991+
"properties": {},
1992+
"type": "object"
1993+
},
19261994
"EnableServiceAccountRequest": {
19271995
"description": "The service account enable request.",
19281996
"id": "EnableServiceAccountRequest",
@@ -2536,6 +2604,10 @@
25362604
"description": "Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing. Public keys for all service accounts are also published at the OAuth2 Service Account API.",
25372605
"id": "ServiceAccountKey",
25382606
"properties": {
2607+
"disabled": {
2608+
"description": "The key status.",
2609+
"type": "boolean"
2610+
},
25392611
"keyAlgorithm": {
25402612
"description": "Specifies the algorithm (and possibly key size) for the key.",
25412613
"enum": [

0 commit comments

Comments
 (0)