Skip to content

Commit 4766121

Browse files
feat(cloudidentity): update the api
#### cloudidentity:v1beta1 The following keys were added: - resources.groups.methods.getSecuritySettings (Total Keys: 14) - resources.groups.methods.updateSecuritySettings (Total Keys: 15) - schemas.MemberRestriction (Total Keys: 4) - schemas.MembershipRole.properties.restrictionEvaluations.$ref (Total Keys: 1) - schemas.MembershipRoleRestrictionEvaluation (Total Keys: 4) - schemas.RestrictionEvaluation (Total Keys: 7) - schemas.SecuritySettings (Total Keys: 5)
1 parent 0ab348f commit 4766121

File tree

4 files changed

+283
-4
lines changed

4 files changed

+283
-4
lines changed

docs/dyn/cloudidentity_v1beta1.groups.html

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,9 @@ <h2>Instance Methods</h2>
9191
<p class="toc_element">
9292
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
9393
<p class="firstline">Retrieves a `Group`.</p>
94+
<p class="toc_element">
95+
<code><a href="#getSecuritySettings">getSecuritySettings(name, readMask=None, x__xgafv=None)</a></code></p>
96+
<p class="firstline">Get Security Settings</p>
9497
<p class="toc_element">
9598
<code><a href="#list">list(pageSize=None, pageToken=None, parent=None, view=None, x__xgafv=None)</a></code></p>
9699
<p class="firstline">Lists the `Group` resources under a customer or namespace.</p>
@@ -109,6 +112,9 @@ <h2>Instance Methods</h2>
109112
<p class="toc_element">
110113
<code><a href="#search_next">search_next(previous_request, previous_response)</a></code></p>
111114
<p class="firstline">Retrieves the next page of results.</p>
115+
<p class="toc_element">
116+
<code><a href="#updateSecuritySettings">updateSecuritySettings(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
117+
<p class="firstline">Update Security Settings</p>
112118
<h3>Method Details</h3>
113119
<div class="method">
114120
<code class="details" id="close">close()</code>
@@ -289,6 +295,32 @@ <h3>Method Details</h3>
289295
}</pre>
290296
</div>
291297

298+
<div class="method">
299+
<code class="details" id="getSecuritySettings">getSecuritySettings(name, readMask=None, x__xgafv=None)</code>
300+
<pre>Get Security Settings
301+
302+
Args:
303+
name: string, Required. The security settings to retrieve. Format: `groups/{group_id}/securitySettings` (required)
304+
readMask: string, Field-level read mask of which fields to return. &quot;*&quot; returns all fields. If not specified, all fields will be returned. May only contain the following field: `member_restriction`.
305+
x__xgafv: string, V1 error format.
306+
Allowed values
307+
1 - v1 error format
308+
2 - v2 error format
309+
310+
Returns:
311+
An object of the form:
312+
313+
{ # The definiion of security settings.
314+
&quot;memberRestriction&quot;: { # The definition of MemberRestriction # The Member Restriction value
315+
&quot;evaluation&quot;: { # The evaluated state of this restriction. # The evaluated state of this restriction on a group.
316+
&quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the restriction
317+
},
318+
&quot;query&quot;: &quot;A String&quot;, # Member Restriction as defined by CEL expression. Supported restrictions are: `member.customer_id` and `member.type`. Valid values for `member.type` are `1`, `2` and `3`. They correspond to USER, SERVICE_ACCOUNT, and GROUP respectively. The value for `member.customer_id` only supports `groupCustomerId()` currently which means the customer id of the group will be used for restriction. Supported operators are `&amp;&amp;`, `||` and `==`, corresponding to AND, OR, and EQUAL. Examples: Allow only service accounts of given customer to be members. `member.type == 2 &amp;&amp; member.customer_id == groupCustomerId()` Allow only users or groups to be members. `member.type == 1 || member.type == 3`
319+
},
320+
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the security settings. Shall be of the form `groups/{group_id}/securitySettings`.
321+
}</pre>
322+
</div>
323+
292324
<div class="method">
293325
<code class="details" id="list">list(pageSize=None, pageToken=None, parent=None, view=None, x__xgafv=None)</code>
294326
<pre>Lists the `Group` resources under a customer or namespace.
@@ -552,4 +584,53 @@ <h3>Method Details</h3>
552584
</pre>
553585
</div>
554586

587+
<div class="method">
588+
<code class="details" id="updateSecuritySettings">updateSecuritySettings(name, body=None, updateMask=None, x__xgafv=None)</code>
589+
<pre>Update Security Settings
590+
591+
Args:
592+
name: string, Output only. The resource name of the security settings. Shall be of the form `groups/{group_id}/securitySettings`. (required)
593+
body: object, The request body.
594+
The object takes the form of:
595+
596+
{ # The definiion of security settings.
597+
&quot;memberRestriction&quot;: { # The definition of MemberRestriction # The Member Restriction value
598+
&quot;evaluation&quot;: { # The evaluated state of this restriction. # The evaluated state of this restriction on a group.
599+
&quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the restriction
600+
},
601+
&quot;query&quot;: &quot;A String&quot;, # Member Restriction as defined by CEL expression. Supported restrictions are: `member.customer_id` and `member.type`. Valid values for `member.type` are `1`, `2` and `3`. They correspond to USER, SERVICE_ACCOUNT, and GROUP respectively. The value for `member.customer_id` only supports `groupCustomerId()` currently which means the customer id of the group will be used for restriction. Supported operators are `&amp;&amp;`, `||` and `==`, corresponding to AND, OR, and EQUAL. Examples: Allow only service accounts of given customer to be members. `member.type == 2 &amp;&amp; member.customer_id == groupCustomerId()` Allow only users or groups to be members. `member.type == 1 || member.type == 3`
602+
},
603+
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the security settings. Shall be of the form `groups/{group_id}/securitySettings`.
604+
}
605+
606+
updateMask: string, Required. The fully-qualified names of fields to update. May only contain the following field: `member_restriction.query`.
607+
x__xgafv: string, V1 error format.
608+
Allowed values
609+
1 - v1 error format
610+
2 - v2 error format
611+
612+
Returns:
613+
An object of the form:
614+
615+
{ # This resource represents a long-running operation that is the result of a network API call.
616+
&quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
617+
&quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
618+
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
619+
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
620+
{
621+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
622+
},
623+
],
624+
&quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
625+
},
626+
&quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
627+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
628+
},
629+
&quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
630+
&quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
631+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
632+
},
633+
}</pre>
634+
</div>
635+
555636
</body></html>

docs/dyn/cloudidentity_v1beta1.groups.memberships.html

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,11 @@ <h3>Method Details</h3>
168168
&quot;expireTime&quot;: &quot;A String&quot;, # The time at which the `MembershipRole` will expire.
169169
},
170170
&quot;name&quot;: &quot;A String&quot;, # The name of the `MembershipRole`. Must be one of `OWNER`, `MANAGER`, `MEMBER`.
171+
&quot;restrictionEvaluations&quot;: { # Evaluations of restrictions applied to parent group on this membership. # Evaluations of restrictions applied to parent group on this membership.
172+
&quot;memberRestrictionEvaluation&quot;: { # The evaluated state of this restriction. # Evaluation of the member restriction applied to this membership. Empty if the user lacks permission to view the restriction evaluation.
173+
&quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the restriction
174+
},
175+
},
171176
},
172177
],
173178
&quot;type&quot;: &quot;A String&quot;, # Output only. The type of the membership.
@@ -269,6 +274,11 @@ <h3>Method Details</h3>
269274
&quot;expireTime&quot;: &quot;A String&quot;, # The time at which the `MembershipRole` will expire.
270275
},
271276
&quot;name&quot;: &quot;A String&quot;, # The name of the `MembershipRole`. Must be one of `OWNER`, `MANAGER`, `MEMBER`.
277+
&quot;restrictionEvaluations&quot;: { # Evaluations of restrictions applied to parent group on this membership. # Evaluations of restrictions applied to parent group on this membership.
278+
&quot;memberRestrictionEvaluation&quot;: { # The evaluated state of this restriction. # Evaluation of the member restriction applied to this membership. Empty if the user lacks permission to view the restriction evaluation.
279+
&quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the restriction
280+
},
281+
},
272282
},
273283
],
274284
&quot;type&quot;: &quot;A String&quot;, # Output only. The type of the membership.
@@ -351,6 +361,11 @@ <h3>Method Details</h3>
351361
&quot;expireTime&quot;: &quot;A String&quot;, # The time at which the `MembershipRole` will expire.
352362
},
353363
&quot;name&quot;: &quot;A String&quot;, # The name of the `MembershipRole`. Must be one of `OWNER`, `MANAGER`, `MEMBER`.
364+
&quot;restrictionEvaluations&quot;: { # Evaluations of restrictions applied to parent group on this membership. # Evaluations of restrictions applied to parent group on this membership.
365+
&quot;memberRestrictionEvaluation&quot;: { # The evaluated state of this restriction. # Evaluation of the member restriction applied to this membership. Empty if the user lacks permission to view the restriction evaluation.
366+
&quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the restriction
367+
},
368+
},
354369
},
355370
],
356371
&quot;type&quot;: &quot;A String&quot;, # Output only. The type of the membership.
@@ -412,6 +427,11 @@ <h3>Method Details</h3>
412427
&quot;expireTime&quot;: &quot;A String&quot;, # The time at which the `MembershipRole` will expire.
413428
},
414429
&quot;name&quot;: &quot;A String&quot;, # The name of the `MembershipRole`. Must be one of `OWNER`, `MANAGER`, `MEMBER`.
430+
&quot;restrictionEvaluations&quot;: { # Evaluations of restrictions applied to parent group on this membership. # Evaluations of restrictions applied to parent group on this membership.
431+
&quot;memberRestrictionEvaluation&quot;: { # The evaluated state of this restriction. # Evaluation of the member restriction applied to this membership. Empty if the user lacks permission to view the restriction evaluation.
432+
&quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the restriction
433+
},
434+
},
415435
},
416436
],
417437
&quot;removeRoles&quot;: [ # The `name`s of the `MembershipRole`s to be removed. Adding or removing roles in the same request as updating roles is not supported. It is not possible to remove the `MEMBER` `MembershipRole`. If you wish to delete a `Membership`, call MembershipsService.DeleteMembership instead. Must not contain `MEMBER`. Must not be set if `update_roles_params` is set.
@@ -425,6 +445,11 @@ <h3>Method Details</h3>
425445
&quot;expireTime&quot;: &quot;A String&quot;, # The time at which the `MembershipRole` will expire.
426446
},
427447
&quot;name&quot;: &quot;A String&quot;, # The name of the `MembershipRole`. Must be one of `OWNER`, `MANAGER`, `MEMBER`.
448+
&quot;restrictionEvaluations&quot;: { # Evaluations of restrictions applied to parent group on this membership. # Evaluations of restrictions applied to parent group on this membership.
449+
&quot;memberRestrictionEvaluation&quot;: { # The evaluated state of this restriction. # Evaluation of the member restriction applied to this membership. Empty if the user lacks permission to view the restriction evaluation.
450+
&quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the restriction
451+
},
452+
},
428453
},
429454
},
430455
],
@@ -456,6 +481,11 @@ <h3>Method Details</h3>
456481
&quot;expireTime&quot;: &quot;A String&quot;, # The time at which the `MembershipRole` will expire.
457482
},
458483
&quot;name&quot;: &quot;A String&quot;, # The name of the `MembershipRole`. Must be one of `OWNER`, `MANAGER`, `MEMBER`.
484+
&quot;restrictionEvaluations&quot;: { # Evaluations of restrictions applied to parent group on this membership. # Evaluations of restrictions applied to parent group on this membership.
485+
&quot;memberRestrictionEvaluation&quot;: { # The evaluated state of this restriction. # Evaluation of the member restriction applied to this membership. Empty if the user lacks permission to view the restriction evaluation.
486+
&quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the restriction
487+
},
488+
},
459489
},
460490
],
461491
&quot;type&quot;: &quot;A String&quot;, # Output only. The type of the membership.

googleapiclient/discovery_cache/documents/cloudidentity.v1.json

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1273,7 +1273,7 @@
12731273
}
12741274
}
12751275
},
1276-
"revision": "20210920",
1276+
"revision": "20210928",
12771277
"rootUrl": "https://cloudidentity.googleapis.com/",
12781278
"schemas": {
12791279
"CheckTransitiveMembershipResponse": {
@@ -1362,12 +1362,14 @@
13621362
"enum": [
13631363
"STATUS_UNSPECIFIED",
13641364
"UP_TO_DATE",
1365-
"UPDATING_MEMBERSHIPS"
1365+
"UPDATING_MEMBERSHIPS",
1366+
"INVALID_QUERY"
13661367
],
13671368
"enumDescriptions": [
13681369
"Default.",
13691370
"The dynamic group is up-to-date.",
1370-
"The dynamic group has just been created and memberships are being updated."
1371+
"The dynamic group has just been created and memberships are being updated.",
1372+
"Group is in an unrecoverable state and its memberships can't be updated."
13711373
],
13721374
"type": "string"
13731375
},

0 commit comments

Comments
 (0)