Skip to content

Commit d55d33d

Browse files
feat(cloudidentity): update the api
#### cloudidentity:v1beta1 The following keys were added: - resources.policies.methods.create (Total Keys: 8) - resources.policies.methods.delete (Total Keys: 11) - resources.policies.methods.patch (Total Keys: 12)
1 parent c40d929 commit d55d33d

File tree

4 files changed

+240
-14
lines changed

4 files changed

+240
-14
lines changed

docs/dyn/cloudidentity_v1.policies.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -79,10 +79,10 @@ <h2>Instance Methods</h2>
7979
<p class="firstline">Close httplib2 connections.</p>
8080
<p class="toc_element">
8181
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
82-
<p class="firstline">Get a Policy</p>
82+
<p class="firstline">Get a policy.</p>
8383
<p class="toc_element">
8484
<code><a href="#list">list(filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
85-
<p class="firstline">List Policies</p>
85+
<p class="firstline">List policies.</p>
8686
<p class="toc_element">
8787
<code><a href="#list_next">list_next()</a></code></p>
8888
<p class="firstline">Retrieves the next page of results.</p>
@@ -94,7 +94,7 @@ <h3>Method Details</h3>
9494

9595
<div class="method">
9696
<code class="details" id="get">get(name, x__xgafv=None)</code>
97-
<pre>Get a Policy
97+
<pre>Get a policy.
9898

9999
Args:
100100
name: string, Required. The name of the policy to retrieve. Format: &quot;policies/{policy}&quot;. (required)
@@ -127,7 +127,7 @@ <h3>Method Details</h3>
127127

128128
<div class="method">
129129
<code class="details" id="list">list(filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
130-
<pre>List Policies
130+
<pre>List policies.
131131

132132
Args:
133133
filter: string, Optional. A CEL expression for filtering the results. Policies can be filtered by application with this expression: setting.type.matches(&#x27;^settings/gmail\\..*$&#x27;) Policies can be filtered by setting type with this expression: setting.type.matches(&#x27;^.*\\.service_status$&#x27;) A maximum of one of the above setting.type clauses can be used. Policies can be filtered by customer with this expression: customer == &quot;customers/{customer}&quot; Where `customer` is the `id` from the [Admin SDK `Customer` resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). You may use `customers/my_customer` to specify your own organization. When no customer is mentioned it will be default to customers/my_customer. A maximum of one customer clause can be used. The above clauses can only be combined together in a single filter expression with the `&amp;&amp;` operator.

docs/dyn/cloudidentity_v1beta1.policies.html

Lines changed: 159 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -77,24 +77,123 @@ <h2>Instance Methods</h2>
7777
<p class="toc_element">
7878
<code><a href="#close">close()</a></code></p>
7979
<p class="firstline">Close httplib2 connections.</p>
80+
<p class="toc_element">
81+
<code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
82+
<p class="firstline">Create a policy.</p>
83+
<p class="toc_element">
84+
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
85+
<p class="firstline">Delete a policy.</p>
8086
<p class="toc_element">
8187
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
82-
<p class="firstline">Get a Policy</p>
88+
<p class="firstline">Get a policy.</p>
8389
<p class="toc_element">
8490
<code><a href="#list">list(filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
85-
<p class="firstline">List Policies</p>
91+
<p class="firstline">List policies.</p>
8692
<p class="toc_element">
8793
<code><a href="#list_next">list_next()</a></code></p>
8894
<p class="firstline">Retrieves the next page of results.</p>
95+
<p class="toc_element">
96+
<code><a href="#patch">patch(name, body=None, x__xgafv=None)</a></code></p>
97+
<p class="firstline">Update a policy.</p>
8998
<h3>Method Details</h3>
9099
<div class="method">
91100
<code class="details" id="close">close()</code>
92101
<pre>Close httplib2 connections.</pre>
93102
</div>
94103

104+
<div class="method">
105+
<code class="details" id="create">create(body=None, x__xgafv=None)</code>
106+
<pre>Create a policy.
107+
108+
Args:
109+
body: object, The request body.
110+
The object takes the form of:
111+
112+
{ # A Policy resource binds an instance of a single Setting with the scope of a PolicyQuery. The Setting instance will be applied to all entities that satisfy the query.
113+
&quot;customer&quot;: &quot;A String&quot;, # Immutable. Customer that the Policy belongs to. The value is in the format &#x27;customers/{customerId}&#x27;. The `customerId` must begin with &quot;C&quot; To find your customer ID in Admin Console see https://support.google.com/a/answer/10070793.
114+
&quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The [resource name](https://cloud.google.com/apis/design/resource_names) of the Policy. Format: policies/{policy}.
115+
&quot;policyQuery&quot;: { # PolicyQuery # Required. The PolicyQuery the Setting applies to.
116+
&quot;group&quot;: &quot;A String&quot;, # Immutable. The group that the query applies to. This field is only set if there is a single value for group that satisfies all clauses of the query. If no group applies, this will be the empty string.
117+
&quot;orgUnit&quot;: &quot;A String&quot;, # Required. Immutable. Non-empty default. The OrgUnit the query applies to. This field is only set if there is a single value for org_unit that satisfies all clauses of the query.
118+
&quot;query&quot;: &quot;A String&quot;, # Immutable. The CEL query that defines which entities the Policy applies to (ex. a User entity). For details about CEL see https://opensource.google.com/projects/cel. The OrgUnits the Policy applies to are represented by a clause like so: entity.org_units.exists(org_unit, org_unit.org_unit_id == orgUnitId(&#x27;{orgUnitId}&#x27;)) The Group the Policy applies to are represented by a clause like so: entity.groups.exists(group, group.group_id == groupId(&#x27;{groupId}&#x27;)) The Licenses the Policy applies to are represented by a clause like so: entity.licenses.exists(license, license in [&#x27;/product/{productId}/sku/{skuId}&#x27;]) The above clauses can be present in any combination, and used in conjunction with the &amp;&amp;, || and ! operators. The org_unit and group fields below are helper fields that contain the corresponding value(s) as the query to make the query easier to use.
119+
&quot;sortOrder&quot;: 3.14, # Output only. The decimal sort order of this PolicyQuery. The value is relative to all other policies with the same setting type for the customer. (There are no duplicates within this set).
120+
},
121+
&quot;setting&quot;: { # Setting # Required. The Setting configured by this Policy.
122+
&quot;type&quot;: &quot;A String&quot;, # Required. Immutable. The type of the Setting. .
123+
&quot;value&quot;: { # Required. The value of the Setting.
124+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
125+
},
126+
},
127+
&quot;type&quot;: &quot;A String&quot;, # Output only. The type of the policy.
128+
}
129+
130+
x__xgafv: string, V1 error format.
131+
Allowed values
132+
1 - v1 error format
133+
2 - v2 error format
134+
135+
Returns:
136+
An object of the form:
137+
138+
{ # This resource represents a long-running operation that is the result of a network API call.
139+
&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.
140+
&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.
141+
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
142+
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
143+
{
144+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
145+
},
146+
],
147+
&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.
148+
},
149+
&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.
150+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
151+
},
152+
&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}`.
153+
&quot;response&quot;: { # The normal, successful response of the operation. 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`.
154+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
155+
},
156+
}</pre>
157+
</div>
158+
159+
<div class="method">
160+
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
161+
<pre>Delete a policy.
162+
163+
Args:
164+
name: string, Required. The name of the policy to retrieve. Format: &quot;policies/{policy}&quot;. (required)
165+
x__xgafv: string, V1 error format.
166+
Allowed values
167+
1 - v1 error format
168+
2 - v2 error format
169+
170+
Returns:
171+
An object of the form:
172+
173+
{ # This resource represents a long-running operation that is the result of a network API call.
174+
&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.
175+
&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.
176+
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
177+
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
178+
{
179+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
180+
},
181+
],
182+
&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.
183+
},
184+
&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.
185+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
186+
},
187+
&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}`.
188+
&quot;response&quot;: { # The normal, successful response of the operation. 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`.
189+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
190+
},
191+
}</pre>
192+
</div>
193+
95194
<div class="method">
96195
<code class="details" id="get">get(name, x__xgafv=None)</code>
97-
<pre>Get a Policy
196+
<pre>Get a policy.
98197

99198
Args:
100199
name: string, Required. The name of the policy to retrieve. Format: &quot;policies/{policy}&quot;. (required)
@@ -127,7 +226,7 @@ <h3>Method Details</h3>
127226

128227
<div class="method">
129228
<code class="details" id="list">list(filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
130-
<pre>List Policies
229+
<pre>List policies.
131230

132231
Args:
133232
filter: string, Optional. A CEL expression for filtering the results. Policies can be filtered by application with this expression: setting.type.matches(&#x27;^settings/gmail\\..*$&#x27;) Policies can be filtered by setting type with this expression: setting.type.matches(&#x27;^.*\\.service_status$&#x27;) A maximum of one of the above setting.type clauses can be used. Policies can be filtered by customer with this expression: customer == &quot;customers/{customer}&quot; Where `customer` is the `id` from the [Admin SDK `Customer` resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). You may use `customers/my_customer` to specify your own organization. When no customer is mentioned it will be default to customers/my_customer. A maximum of one customer clause can be used. The above clauses can only be combined together in a single filter expression with the `&amp;&amp;` operator.
@@ -179,4 +278,60 @@ <h3>Method Details</h3>
179278
</pre>
180279
</div>
181280

281+
<div class="method">
282+
<code class="details" id="patch">patch(name, body=None, x__xgafv=None)</code>
283+
<pre>Update a policy.
284+
285+
Args:
286+
name: string, Output only. Identifier. The [resource name](https://cloud.google.com/apis/design/resource_names) of the Policy. Format: policies/{policy}. (required)
287+
body: object, The request body.
288+
The object takes the form of:
289+
290+
{ # A Policy resource binds an instance of a single Setting with the scope of a PolicyQuery. The Setting instance will be applied to all entities that satisfy the query.
291+
&quot;customer&quot;: &quot;A String&quot;, # Immutable. Customer that the Policy belongs to. The value is in the format &#x27;customers/{customerId}&#x27;. The `customerId` must begin with &quot;C&quot; To find your customer ID in Admin Console see https://support.google.com/a/answer/10070793.
292+
&quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The [resource name](https://cloud.google.com/apis/design/resource_names) of the Policy. Format: policies/{policy}.
293+
&quot;policyQuery&quot;: { # PolicyQuery # Required. The PolicyQuery the Setting applies to.
294+
&quot;group&quot;: &quot;A String&quot;, # Immutable. The group that the query applies to. This field is only set if there is a single value for group that satisfies all clauses of the query. If no group applies, this will be the empty string.
295+
&quot;orgUnit&quot;: &quot;A String&quot;, # Required. Immutable. Non-empty default. The OrgUnit the query applies to. This field is only set if there is a single value for org_unit that satisfies all clauses of the query.
296+
&quot;query&quot;: &quot;A String&quot;, # Immutable. The CEL query that defines which entities the Policy applies to (ex. a User entity). For details about CEL see https://opensource.google.com/projects/cel. The OrgUnits the Policy applies to are represented by a clause like so: entity.org_units.exists(org_unit, org_unit.org_unit_id == orgUnitId(&#x27;{orgUnitId}&#x27;)) The Group the Policy applies to are represented by a clause like so: entity.groups.exists(group, group.group_id == groupId(&#x27;{groupId}&#x27;)) The Licenses the Policy applies to are represented by a clause like so: entity.licenses.exists(license, license in [&#x27;/product/{productId}/sku/{skuId}&#x27;]) The above clauses can be present in any combination, and used in conjunction with the &amp;&amp;, || and ! operators. The org_unit and group fields below are helper fields that contain the corresponding value(s) as the query to make the query easier to use.
297+
&quot;sortOrder&quot;: 3.14, # Output only. The decimal sort order of this PolicyQuery. The value is relative to all other policies with the same setting type for the customer. (There are no duplicates within this set).
298+
},
299+
&quot;setting&quot;: { # Setting # Required. The Setting configured by this Policy.
300+
&quot;type&quot;: &quot;A String&quot;, # Required. Immutable. The type of the Setting. .
301+
&quot;value&quot;: { # Required. The value of the Setting.
302+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
303+
},
304+
},
305+
&quot;type&quot;: &quot;A String&quot;, # Output only. The type of the policy.
306+
}
307+
308+
x__xgafv: string, V1 error format.
309+
Allowed values
310+
1 - v1 error format
311+
2 - v2 error format
312+
313+
Returns:
314+
An object of the form:
315+
316+
{ # This resource represents a long-running operation that is the result of a network API call.
317+
&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.
318+
&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.
319+
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
320+
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
321+
{
322+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
323+
},
324+
],
325+
&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.
326+
},
327+
&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.
328+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
329+
},
330+
&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}`.
331+
&quot;response&quot;: { # The normal, successful response of the operation. 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`.
332+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
333+
},
334+
}</pre>
335+
</div>
336+
182337
</body></html>

0 commit comments

Comments
 (0)