Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 67ece72

Browse files
committedDec 7, 2023
feat(firebaseappcheck): update the api
#### firebaseappcheck:v1beta The following keys were added: - resources.projects.resources.services.resources.resourcePolicies.methods.batchUpdate (Total Keys: 12) - resources.projects.resources.services.resources.resourcePolicies.methods.create (Total Keys: 12) - resources.projects.resources.services.resources.resourcePolicies.methods.delete (Total Keys: 11) - resources.projects.resources.services.resources.resourcePolicies.methods.get (Total Keys: 11) - resources.projects.resources.services.resources.resourcePolicies.methods.list (Total Keys: 16) - resources.projects.resources.services.resources.resourcePolicies.methods.patch (Total Keys: 15) - schemas.GoogleFirebaseAppcheckV1betaBatchUpdateResourcePoliciesRequest (Total Keys: 6) - schemas.GoogleFirebaseAppcheckV1betaBatchUpdateResourcePoliciesResponse (Total Keys: 4) - schemas.GoogleFirebaseAppcheckV1betaListResourcePoliciesResponse (Total Keys: 5) - schemas.GoogleFirebaseAppcheckV1betaResourcePolicy (Total Keys: 8) - schemas.GoogleFirebaseAppcheckV1betaUpdateResourcePolicyRequest (Total Keys: 5)
1 parent 98ba880 commit 67ece72

4 files changed

+614
-2
lines changed
 

‎docs/dyn/firebaseappcheck_v1beta.projects.services.html

+5
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,11 @@
7474

7575
<h1><a href="firebaseappcheck_v1beta.html">Firebase App Check API</a> . <a href="firebaseappcheck_v1beta.projects.html">projects</a> . <a href="firebaseappcheck_v1beta.projects.services.html">services</a></h1>
7676
<h2>Instance Methods</h2>
77+
<p class="toc_element">
78+
<code><a href="firebaseappcheck_v1beta.projects.services.resourcePolicies.html">resourcePolicies()</a></code>
79+
</p>
80+
<p class="firstline">Returns the resourcePolicies Resource.</p>
81+
7782
<p class="toc_element">
7883
<code><a href="#batchUpdate">batchUpdate(parent, body=None, x__xgafv=None)</a></code></p>
7984
<p class="firstline">Atomically updates the specified Service configurations.</p>
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,308 @@
1+
<html><body>
2+
<style>
3+
4+
body, h1, h2, h3, div, span, p, pre, a {
5+
margin: 0;
6+
padding: 0;
7+
border: 0;
8+
font-weight: inherit;
9+
font-style: inherit;
10+
font-size: 100%;
11+
font-family: inherit;
12+
vertical-align: baseline;
13+
}
14+
15+
body {
16+
font-size: 13px;
17+
padding: 1em;
18+
}
19+
20+
h1 {
21+
font-size: 26px;
22+
margin-bottom: 1em;
23+
}
24+
25+
h2 {
26+
font-size: 24px;
27+
margin-bottom: 1em;
28+
}
29+
30+
h3 {
31+
font-size: 20px;
32+
margin-bottom: 1em;
33+
margin-top: 1em;
34+
}
35+
36+
pre, code {
37+
line-height: 1.5;
38+
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39+
}
40+
41+
pre {
42+
margin-top: 0.5em;
43+
}
44+
45+
h1, h2, h3, p {
46+
font-family: Arial, sans serif;
47+
}
48+
49+
h1, h2, h3 {
50+
border-bottom: solid #CCC 1px;
51+
}
52+
53+
.toc_element {
54+
margin-top: 0.5em;
55+
}
56+
57+
.firstline {
58+
margin-left: 2 em;
59+
}
60+
61+
.method {
62+
margin-top: 1em;
63+
border: solid 1px #CCC;
64+
padding: 1em;
65+
background: #EEE;
66+
}
67+
68+
.details {
69+
font-weight: bold;
70+
font-size: 14px;
71+
}
72+
73+
</style>
74+
75+
<h1><a href="firebaseappcheck_v1beta.html">Firebase App Check API</a> . <a href="firebaseappcheck_v1beta.projects.html">projects</a> . <a href="firebaseappcheck_v1beta.projects.services.html">services</a> . <a href="firebaseappcheck_v1beta.projects.services.resourcePolicies.html">resourcePolicies</a></h1>
76+
<h2>Instance Methods</h2>
77+
<p class="toc_element">
78+
<code><a href="#batchUpdate">batchUpdate(parent, body=None, x__xgafv=None)</a></code></p>
79+
<p class="firstline">Atomically updates the specified ResourcePolicy configurations.</p>
80+
<p class="toc_element">
81+
<code><a href="#close">close()</a></code></p>
82+
<p class="firstline">Close httplib2 connections.</p>
83+
<p class="toc_element">
84+
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
85+
<p class="firstline">Creates the specified ResourcePolicy configuration.</p>
86+
<p class="toc_element">
87+
<code><a href="#delete">delete(name, etag=None, x__xgafv=None)</a></code></p>
88+
<p class="firstline">Deletes the specified ResourcePolicy configuration.</p>
89+
<p class="toc_element">
90+
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
91+
<p class="firstline">Gets the requested ResourcePolicy configuration.</p>
92+
<p class="toc_element">
93+
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
94+
<p class="firstline">Lists all ResourcePolicy configurations for the specified project and service.</p>
95+
<p class="toc_element">
96+
<code><a href="#list_next">list_next()</a></code></p>
97+
<p class="firstline">Retrieves the next page of results.</p>
98+
<p class="toc_element">
99+
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
100+
<p class="firstline">Updates the specified ResourcePolicy configuration.</p>
101+
<h3>Method Details</h3>
102+
<div class="method">
103+
<code class="details" id="batchUpdate">batchUpdate(parent, body=None, x__xgafv=None)</code>
104+
<pre>Atomically updates the specified ResourcePolicy configurations.
105+
106+
Args:
107+
parent: string, Required. The parent project name and the service, in the format ``` projects/{project_number}/services/{service_id} ``` The parent collection in the `name` field of any resource being updated must match this field, or the entire batch fails. (required)
108+
body: object, The request body.
109+
The object takes the form of:
110+
111+
{ # Request message for the BatchUpdateResourcePolicies method.
112+
&quot;requests&quot;: [ # Required. The request messages specifying the ResourcePolicys to update. A maximum of 100 objects can be updated in a batch.
113+
{ # Request message for the UpdateResourcePolicy method as well as an individual update message for the BatchUpdateResourcePolicies method.
114+
&quot;resourcePolicy&quot;: { # App Check enforcement policy for a specific resource of a Firebase service supported by App Check. Note that this policy will override the Service level enforcement mode configuration. # Required. The ResourcePolicy to update. The ResourcePolicy&#x27;s `name` field is used to identify the ResourcePolicy to be updated, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_name} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) Only the top-level resources are supported for each of the services. The resources must belong to the service specified and `resource_name` should be formatted as: * `oauthClients/{oauth_client_id}` (Google Identity for iOS)
115+
&quot;enforcementMode&quot;: &quot;A String&quot;, # Required. The App Check enforcement mode for this resource. This will override the EnforcementMode setting on the service. For new resources that you are creating, you should consider setting an override and enable enforcement on the resource immediately, if there are no outdated clients that can use it.
116+
&quot;etag&quot;: &quot;A String&quot;, # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated.
117+
&quot;name&quot;: &quot;A String&quot;, # Required. The relative name of the resource configuration object, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID used as the resource ID for the policy.
118+
&quot;targetResource&quot;: &quot;A String&quot;, # Required. Service specific name of the resource object to which this policy applies, in the format: * `//oauth2.googleapis.com/projects/{project}/oauthClients/{oauth_client_id}` (Google Identity for iOS) NOTE that the resource must belong to the service specified in the `name` and be from the same project as this policy, but it may or may not exist at the time of creation of the policy.
119+
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this service configuration object was most recently updated.
120+
},
121+
&quot;updateMask&quot;: &quot;A String&quot;, # Required. A comma-separated list of names of fields in the ResourcePolicy to update. Example: `enforcement_mode`.
122+
},
123+
],
124+
&quot;updateMask&quot;: &quot;A String&quot;, # Optional. A comma-separated list of names of fields in the ResourceConfigurations to update. Example: `enforcement_mode`. If this field is present, the `update_mask` field in the UpdateResourcePolicyRequest messages must all match this field, or the entire batch fails and no updates will be committed.
125+
}
126+
127+
x__xgafv: string, V1 error format.
128+
Allowed values
129+
1 - v1 error format
130+
2 - v2 error format
131+
132+
Returns:
133+
An object of the form:
134+
135+
{ # Response message for the BatchUpdateResourcePolicies method.
136+
&quot;resourcePolicies&quot;: [ # ResourcePolicy objects after the updates have been applied.
137+
{ # App Check enforcement policy for a specific resource of a Firebase service supported by App Check. Note that this policy will override the Service level enforcement mode configuration.
138+
&quot;enforcementMode&quot;: &quot;A String&quot;, # Required. The App Check enforcement mode for this resource. This will override the EnforcementMode setting on the service. For new resources that you are creating, you should consider setting an override and enable enforcement on the resource immediately, if there are no outdated clients that can use it.
139+
&quot;etag&quot;: &quot;A String&quot;, # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated.
140+
&quot;name&quot;: &quot;A String&quot;, # Required. The relative name of the resource configuration object, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID used as the resource ID for the policy.
141+
&quot;targetResource&quot;: &quot;A String&quot;, # Required. Service specific name of the resource object to which this policy applies, in the format: * `//oauth2.googleapis.com/projects/{project}/oauthClients/{oauth_client_id}` (Google Identity for iOS) NOTE that the resource must belong to the service specified in the `name` and be from the same project as this policy, but it may or may not exist at the time of creation of the policy.
142+
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this service configuration object was most recently updated.
143+
},
144+
],
145+
}</pre>
146+
</div>
147+
148+
<div class="method">
149+
<code class="details" id="close">close()</code>
150+
<pre>Close httplib2 connections.</pre>
151+
</div>
152+
153+
<div class="method">
154+
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
155+
<pre>Creates the specified ResourcePolicy configuration.
156+
157+
Args:
158+
parent: string, Required. The relative resource name of the parent service in which the specified ResourcePolicy will be created, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) (required)
159+
body: object, The request body.
160+
The object takes the form of:
161+
162+
{ # App Check enforcement policy for a specific resource of a Firebase service supported by App Check. Note that this policy will override the Service level enforcement mode configuration.
163+
&quot;enforcementMode&quot;: &quot;A String&quot;, # Required. The App Check enforcement mode for this resource. This will override the EnforcementMode setting on the service. For new resources that you are creating, you should consider setting an override and enable enforcement on the resource immediately, if there are no outdated clients that can use it.
164+
&quot;etag&quot;: &quot;A String&quot;, # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated.
165+
&quot;name&quot;: &quot;A String&quot;, # Required. The relative name of the resource configuration object, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID used as the resource ID for the policy.
166+
&quot;targetResource&quot;: &quot;A String&quot;, # Required. Service specific name of the resource object to which this policy applies, in the format: * `//oauth2.googleapis.com/projects/{project}/oauthClients/{oauth_client_id}` (Google Identity for iOS) NOTE that the resource must belong to the service specified in the `name` and be from the same project as this policy, but it may or may not exist at the time of creation of the policy.
167+
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this service configuration object was most recently updated.
168+
}
169+
170+
x__xgafv: string, V1 error format.
171+
Allowed values
172+
1 - v1 error format
173+
2 - v2 error format
174+
175+
Returns:
176+
An object of the form:
177+
178+
{ # App Check enforcement policy for a specific resource of a Firebase service supported by App Check. Note that this policy will override the Service level enforcement mode configuration.
179+
&quot;enforcementMode&quot;: &quot;A String&quot;, # Required. The App Check enforcement mode for this resource. This will override the EnforcementMode setting on the service. For new resources that you are creating, you should consider setting an override and enable enforcement on the resource immediately, if there are no outdated clients that can use it.
180+
&quot;etag&quot;: &quot;A String&quot;, # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated.
181+
&quot;name&quot;: &quot;A String&quot;, # Required. The relative name of the resource configuration object, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID used as the resource ID for the policy.
182+
&quot;targetResource&quot;: &quot;A String&quot;, # Required. Service specific name of the resource object to which this policy applies, in the format: * `//oauth2.googleapis.com/projects/{project}/oauthClients/{oauth_client_id}` (Google Identity for iOS) NOTE that the resource must belong to the service specified in the `name` and be from the same project as this policy, but it may or may not exist at the time of creation of the policy.
183+
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this service configuration object was most recently updated.
184+
}</pre>
185+
</div>
186+
187+
<div class="method">
188+
<code class="details" id="delete">delete(name, etag=None, x__xgafv=None)</code>
189+
<pre>Deletes the specified ResourcePolicy configuration.
190+
191+
Args:
192+
name: string, Required. The relative resource name of the ResourcePolicy to delete, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_name} ``` (required)
193+
etag: string, The checksum to be validated against the current ResourcePolicy, to ensure the client has an up-to-date value before proceeding. The user can obtain this from the ResourcePolicy object that they last received. This etag is strongly validated.
194+
x__xgafv: string, V1 error format.
195+
Allowed values
196+
1 - v1 error format
197+
2 - v2 error format
198+
199+
Returns:
200+
An object of the form:
201+
202+
{ # 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); }
203+
}</pre>
204+
</div>
205+
206+
<div class="method">
207+
<code class="details" id="get">get(name, x__xgafv=None)</code>
208+
<pre>Gets the requested ResourcePolicy configuration.
209+
210+
Args:
211+
name: string, Required. The relative resource name of the ResourcePolicy to retrieve, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID used as the resource ID for the policy. (required)
212+
x__xgafv: string, V1 error format.
213+
Allowed values
214+
1 - v1 error format
215+
2 - v2 error format
216+
217+
Returns:
218+
An object of the form:
219+
220+
{ # App Check enforcement policy for a specific resource of a Firebase service supported by App Check. Note that this policy will override the Service level enforcement mode configuration.
221+
&quot;enforcementMode&quot;: &quot;A String&quot;, # Required. The App Check enforcement mode for this resource. This will override the EnforcementMode setting on the service. For new resources that you are creating, you should consider setting an override and enable enforcement on the resource immediately, if there are no outdated clients that can use it.
222+
&quot;etag&quot;: &quot;A String&quot;, # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated.
223+
&quot;name&quot;: &quot;A String&quot;, # Required. The relative name of the resource configuration object, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID used as the resource ID for the policy.
224+
&quot;targetResource&quot;: &quot;A String&quot;, # Required. Service specific name of the resource object to which this policy applies, in the format: * `//oauth2.googleapis.com/projects/{project}/oauthClients/{oauth_client_id}` (Google Identity for iOS) NOTE that the resource must belong to the service specified in the `name` and be from the same project as this policy, but it may or may not exist at the time of creation of the policy.
225+
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this service configuration object was most recently updated.
226+
}</pre>
227+
</div>
228+
229+
<div class="method">
230+
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
231+
<pre>Lists all ResourcePolicy configurations for the specified project and service.
232+
233+
Args:
234+
parent: string, Required. The relative resource name of the parent project and service for which to list each associated ResourcePolicy, in the format: ``` projects/{project_number}/services/{service_name} ``` (required)
235+
pageSize: integer, The maximum number of ResourcePolicys to return in the response. Only explicitly configured policies are returned. The server may return fewer than this at its own discretion. If no value is specified (or too large a value is specified), the server will impose its own limit.
236+
pageToken: string, Token returned from a previous call to ListResourcePolicies indicating where in the set of ResourcePolicys to resume listing. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListResourcePolicies must match the call that provided the page token; if they do not match, the result is undefined.
237+
x__xgafv: string, V1 error format.
238+
Allowed values
239+
1 - v1 error format
240+
2 - v2 error format
241+
242+
Returns:
243+
An object of the form:
244+
245+
{ # Response message for the ListResourcePolicies method.
246+
&quot;nextPageToken&quot;: &quot;A String&quot;, # If the result list is too large to fit in a single response, then a token is returned. If the string is empty or omitted, then this response is the last page of results. This token can be used in a subsequent call to ListResourcePolicies to find the next group of ResourcePolicys. Page tokens are short-lived and should not be persisted.
247+
&quot;resourcePolicies&quot;: [ # The ResourcePolicys retrieved.
248+
{ # App Check enforcement policy for a specific resource of a Firebase service supported by App Check. Note that this policy will override the Service level enforcement mode configuration.
249+
&quot;enforcementMode&quot;: &quot;A String&quot;, # Required. The App Check enforcement mode for this resource. This will override the EnforcementMode setting on the service. For new resources that you are creating, you should consider setting an override and enable enforcement on the resource immediately, if there are no outdated clients that can use it.
250+
&quot;etag&quot;: &quot;A String&quot;, # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated.
251+
&quot;name&quot;: &quot;A String&quot;, # Required. The relative name of the resource configuration object, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID used as the resource ID for the policy.
252+
&quot;targetResource&quot;: &quot;A String&quot;, # Required. Service specific name of the resource object to which this policy applies, in the format: * `//oauth2.googleapis.com/projects/{project}/oauthClients/{oauth_client_id}` (Google Identity for iOS) NOTE that the resource must belong to the service specified in the `name` and be from the same project as this policy, but it may or may not exist at the time of creation of the policy.
253+
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this service configuration object was most recently updated.
254+
},
255+
],
256+
}</pre>
257+
</div>
258+
259+
<div class="method">
260+
<code class="details" id="list_next">list_next()</code>
261+
<pre>Retrieves the next page of results.
262+
263+
Args:
264+
previous_request: The request for the previous page. (required)
265+
previous_response: The response from the request for the previous page. (required)
266+
267+
Returns:
268+
A request object that you can call &#x27;execute()&#x27; on to request the next
269+
page. Returns None if there are no more items in the collection.
270+
</pre>
271+
</div>
272+
273+
<div class="method">
274+
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
275+
<pre>Updates the specified ResourcePolicy configuration.
276+
277+
Args:
278+
name: string, Required. The relative name of the resource configuration object, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID used as the resource ID for the policy. (required)
279+
body: object, The request body.
280+
The object takes the form of:
281+
282+
{ # App Check enforcement policy for a specific resource of a Firebase service supported by App Check. Note that this policy will override the Service level enforcement mode configuration.
283+
&quot;enforcementMode&quot;: &quot;A String&quot;, # Required. The App Check enforcement mode for this resource. This will override the EnforcementMode setting on the service. For new resources that you are creating, you should consider setting an override and enable enforcement on the resource immediately, if there are no outdated clients that can use it.
284+
&quot;etag&quot;: &quot;A String&quot;, # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated.
285+
&quot;name&quot;: &quot;A String&quot;, # Required. The relative name of the resource configuration object, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID used as the resource ID for the policy.
286+
&quot;targetResource&quot;: &quot;A String&quot;, # Required. Service specific name of the resource object to which this policy applies, in the format: * `//oauth2.googleapis.com/projects/{project}/oauthClients/{oauth_client_id}` (Google Identity for iOS) NOTE that the resource must belong to the service specified in the `name` and be from the same project as this policy, but it may or may not exist at the time of creation of the policy.
287+
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this service configuration object was most recently updated.
288+
}
289+
290+
updateMask: string, Required. A comma-separated list of names of fields in the ResourcePolicy to update. Example: `enforcement_mode`.
291+
x__xgafv: string, V1 error format.
292+
Allowed values
293+
1 - v1 error format
294+
2 - v2 error format
295+
296+
Returns:
297+
An object of the form:
298+
299+
{ # App Check enforcement policy for a specific resource of a Firebase service supported by App Check. Note that this policy will override the Service level enforcement mode configuration.
300+
&quot;enforcementMode&quot;: &quot;A String&quot;, # Required. The App Check enforcement mode for this resource. This will override the EnforcementMode setting on the service. For new resources that you are creating, you should consider setting an override and enable enforcement on the resource immediately, if there are no outdated clients that can use it.
301+
&quot;etag&quot;: &quot;A String&quot;, # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated.
302+
&quot;name&quot;: &quot;A String&quot;, # Required. The relative name of the resource configuration object, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID used as the resource ID for the policy.
303+
&quot;targetResource&quot;: &quot;A String&quot;, # Required. Service specific name of the resource object to which this policy applies, in the format: * `//oauth2.googleapis.com/projects/{project}/oauthClients/{oauth_client_id}` (Google Identity for iOS) NOTE that the resource must belong to the service specified in the `name` and be from the same project as this policy, but it may or may not exist at the time of creation of the policy.
304+
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this service configuration object was most recently updated.
305+
}</pre>
306+
</div>
307+
308+
</body></html>

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1343,7 +1343,7 @@
13431343
}
13441344
}
13451345
},
1346-
"revision": "20231113",
1346+
"revision": "20231204",
13471347
"rootUrl": "https://firebaseappcheck.googleapis.com/",
13481348
"schemas": {
13491349
"GoogleFirebaseAppcheckV1AppAttestConfig": {

‎googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json

+300-1
Original file line numberDiff line numberDiff line change
@@ -1620,12 +1620,205 @@
16201620
"https://www.googleapis.com/auth/firebase"
16211621
]
16221622
}
1623+
},
1624+
"resources": {
1625+
"resourcePolicies": {
1626+
"methods": {
1627+
"batchUpdate": {
1628+
"description": "Atomically updates the specified ResourcePolicy configurations.",
1629+
"flatPath": "v1beta/projects/{projectsId}/services/{servicesId}/resourcePolicies:batchUpdate",
1630+
"httpMethod": "POST",
1631+
"id": "firebaseappcheck.projects.services.resourcePolicies.batchUpdate",
1632+
"parameterOrder": [
1633+
"parent"
1634+
],
1635+
"parameters": {
1636+
"parent": {
1637+
"description": "Required. The parent project name and the service, in the format ``` projects/{project_number}/services/{service_id} ``` The parent collection in the `name` field of any resource being updated must match this field, or the entire batch fails.",
1638+
"location": "path",
1639+
"pattern": "^projects/[^/]+/services/[^/]+$",
1640+
"required": true,
1641+
"type": "string"
1642+
}
1643+
},
1644+
"path": "v1beta/{+parent}/resourcePolicies:batchUpdate",
1645+
"request": {
1646+
"$ref": "GoogleFirebaseAppcheckV1betaBatchUpdateResourcePoliciesRequest"
1647+
},
1648+
"response": {
1649+
"$ref": "GoogleFirebaseAppcheckV1betaBatchUpdateResourcePoliciesResponse"
1650+
},
1651+
"scopes": [
1652+
"https://www.googleapis.com/auth/cloud-platform",
1653+
"https://www.googleapis.com/auth/firebase"
1654+
]
1655+
},
1656+
"create": {
1657+
"description": "Creates the specified ResourcePolicy configuration.",
1658+
"flatPath": "v1beta/projects/{projectsId}/services/{servicesId}/resourcePolicies",
1659+
"httpMethod": "POST",
1660+
"id": "firebaseappcheck.projects.services.resourcePolicies.create",
1661+
"parameterOrder": [
1662+
"parent"
1663+
],
1664+
"parameters": {
1665+
"parent": {
1666+
"description": "Required. The relative resource name of the parent service in which the specified ResourcePolicy will be created, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS)",
1667+
"location": "path",
1668+
"pattern": "^projects/[^/]+/services/[^/]+$",
1669+
"required": true,
1670+
"type": "string"
1671+
}
1672+
},
1673+
"path": "v1beta/{+parent}/resourcePolicies",
1674+
"request": {
1675+
"$ref": "GoogleFirebaseAppcheckV1betaResourcePolicy"
1676+
},
1677+
"response": {
1678+
"$ref": "GoogleFirebaseAppcheckV1betaResourcePolicy"
1679+
},
1680+
"scopes": [
1681+
"https://www.googleapis.com/auth/cloud-platform",
1682+
"https://www.googleapis.com/auth/firebase"
1683+
]
1684+
},
1685+
"delete": {
1686+
"description": "Deletes the specified ResourcePolicy configuration.",
1687+
"flatPath": "v1beta/projects/{projectsId}/services/{servicesId}/resourcePolicies/{resourcePoliciesId}",
1688+
"httpMethod": "DELETE",
1689+
"id": "firebaseappcheck.projects.services.resourcePolicies.delete",
1690+
"parameterOrder": [
1691+
"name"
1692+
],
1693+
"parameters": {
1694+
"etag": {
1695+
"description": "The checksum to be validated against the current ResourcePolicy, to ensure the client has an up-to-date value before proceeding. The user can obtain this from the ResourcePolicy object that they last received. This etag is strongly validated.",
1696+
"location": "query",
1697+
"type": "string"
1698+
},
1699+
"name": {
1700+
"description": "Required. The relative resource name of the ResourcePolicy to delete, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_name} ```",
1701+
"location": "path",
1702+
"pattern": "^projects/[^/]+/services/[^/]+/resourcePolicies/[^/]+$",
1703+
"required": true,
1704+
"type": "string"
1705+
}
1706+
},
1707+
"path": "v1beta/{+name}",
1708+
"response": {
1709+
"$ref": "GoogleProtobufEmpty"
1710+
},
1711+
"scopes": [
1712+
"https://www.googleapis.com/auth/cloud-platform",
1713+
"https://www.googleapis.com/auth/firebase"
1714+
]
1715+
},
1716+
"get": {
1717+
"description": "Gets the requested ResourcePolicy configuration.",
1718+
"flatPath": "v1beta/projects/{projectsId}/services/{servicesId}/resourcePolicies/{resourcePoliciesId}",
1719+
"httpMethod": "GET",
1720+
"id": "firebaseappcheck.projects.services.resourcePolicies.get",
1721+
"parameterOrder": [
1722+
"name"
1723+
],
1724+
"parameters": {
1725+
"name": {
1726+
"description": "Required. The relative resource name of the ResourcePolicy to retrieve, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID used as the resource ID for the policy.",
1727+
"location": "path",
1728+
"pattern": "^projects/[^/]+/services/[^/]+/resourcePolicies/[^/]+$",
1729+
"required": true,
1730+
"type": "string"
1731+
}
1732+
},
1733+
"path": "v1beta/{+name}",
1734+
"response": {
1735+
"$ref": "GoogleFirebaseAppcheckV1betaResourcePolicy"
1736+
},
1737+
"scopes": [
1738+
"https://www.googleapis.com/auth/cloud-platform",
1739+
"https://www.googleapis.com/auth/firebase"
1740+
]
1741+
},
1742+
"list": {
1743+
"description": "Lists all ResourcePolicy configurations for the specified project and service.",
1744+
"flatPath": "v1beta/projects/{projectsId}/services/{servicesId}/resourcePolicies",
1745+
"httpMethod": "GET",
1746+
"id": "firebaseappcheck.projects.services.resourcePolicies.list",
1747+
"parameterOrder": [
1748+
"parent"
1749+
],
1750+
"parameters": {
1751+
"pageSize": {
1752+
"description": "The maximum number of ResourcePolicys to return in the response. Only explicitly configured policies are returned. The server may return fewer than this at its own discretion. If no value is specified (or too large a value is specified), the server will impose its own limit.",
1753+
"format": "int32",
1754+
"location": "query",
1755+
"type": "integer"
1756+
},
1757+
"pageToken": {
1758+
"description": "Token returned from a previous call to ListResourcePolicies indicating where in the set of ResourcePolicys to resume listing. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListResourcePolicies must match the call that provided the page token; if they do not match, the result is undefined.",
1759+
"location": "query",
1760+
"type": "string"
1761+
},
1762+
"parent": {
1763+
"description": "Required. The relative resource name of the parent project and service for which to list each associated ResourcePolicy, in the format: ``` projects/{project_number}/services/{service_name} ```",
1764+
"location": "path",
1765+
"pattern": "^projects/[^/]+/services/[^/]+$",
1766+
"required": true,
1767+
"type": "string"
1768+
}
1769+
},
1770+
"path": "v1beta/{+parent}/resourcePolicies",
1771+
"response": {
1772+
"$ref": "GoogleFirebaseAppcheckV1betaListResourcePoliciesResponse"
1773+
},
1774+
"scopes": [
1775+
"https://www.googleapis.com/auth/cloud-platform",
1776+
"https://www.googleapis.com/auth/firebase"
1777+
]
1778+
},
1779+
"patch": {
1780+
"description": "Updates the specified ResourcePolicy configuration.",
1781+
"flatPath": "v1beta/projects/{projectsId}/services/{servicesId}/resourcePolicies/{resourcePoliciesId}",
1782+
"httpMethod": "PATCH",
1783+
"id": "firebaseappcheck.projects.services.resourcePolicies.patch",
1784+
"parameterOrder": [
1785+
"name"
1786+
],
1787+
"parameters": {
1788+
"name": {
1789+
"description": "Required. The relative name of the resource configuration object, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID used as the resource ID for the policy.",
1790+
"location": "path",
1791+
"pattern": "^projects/[^/]+/services/[^/]+/resourcePolicies/[^/]+$",
1792+
"required": true,
1793+
"type": "string"
1794+
},
1795+
"updateMask": {
1796+
"description": "Required. A comma-separated list of names of fields in the ResourcePolicy to update. Example: `enforcement_mode`.",
1797+
"format": "google-fieldmask",
1798+
"location": "query",
1799+
"type": "string"
1800+
}
1801+
},
1802+
"path": "v1beta/{+name}",
1803+
"request": {
1804+
"$ref": "GoogleFirebaseAppcheckV1betaResourcePolicy"
1805+
},
1806+
"response": {
1807+
"$ref": "GoogleFirebaseAppcheckV1betaResourcePolicy"
1808+
},
1809+
"scopes": [
1810+
"https://www.googleapis.com/auth/cloud-platform",
1811+
"https://www.googleapis.com/auth/firebase"
1812+
]
1813+
}
1814+
}
1815+
}
16231816
}
16241817
}
16251818
}
16261819
}
16271820
},
1628-
"revision": "20231113",
1821+
"revision": "20231204",
16291822
"rootUrl": "https://firebaseappcheck.googleapis.com/",
16301823
"schemas": {
16311824
"GoogleFirebaseAppcheckV1betaAppAttestConfig": {
@@ -1782,6 +1975,39 @@
17821975
},
17831976
"type": "object"
17841977
},
1978+
"GoogleFirebaseAppcheckV1betaBatchUpdateResourcePoliciesRequest": {
1979+
"description": "Request message for the BatchUpdateResourcePolicies method.",
1980+
"id": "GoogleFirebaseAppcheckV1betaBatchUpdateResourcePoliciesRequest",
1981+
"properties": {
1982+
"requests": {
1983+
"description": "Required. The request messages specifying the ResourcePolicys to update. A maximum of 100 objects can be updated in a batch.",
1984+
"items": {
1985+
"$ref": "GoogleFirebaseAppcheckV1betaUpdateResourcePolicyRequest"
1986+
},
1987+
"type": "array"
1988+
},
1989+
"updateMask": {
1990+
"description": "Optional. A comma-separated list of names of fields in the ResourceConfigurations to update. Example: `enforcement_mode`. If this field is present, the `update_mask` field in the UpdateResourcePolicyRequest messages must all match this field, or the entire batch fails and no updates will be committed.",
1991+
"format": "google-fieldmask",
1992+
"type": "string"
1993+
}
1994+
},
1995+
"type": "object"
1996+
},
1997+
"GoogleFirebaseAppcheckV1betaBatchUpdateResourcePoliciesResponse": {
1998+
"description": "Response message for the BatchUpdateResourcePolicies method.",
1999+
"id": "GoogleFirebaseAppcheckV1betaBatchUpdateResourcePoliciesResponse",
2000+
"properties": {
2001+
"resourcePolicies": {
2002+
"description": "ResourcePolicy objects after the updates have been applied.",
2003+
"items": {
2004+
"$ref": "GoogleFirebaseAppcheckV1betaResourcePolicy"
2005+
},
2006+
"type": "array"
2007+
}
2008+
},
2009+
"type": "object"
2010+
},
17852011
"GoogleFirebaseAppcheckV1betaBatchUpdateServicesRequest": {
17862012
"description": "Request message for the BatchUpdateServices method.",
17872013
"id": "GoogleFirebaseAppcheckV1betaBatchUpdateServicesRequest",
@@ -2113,6 +2339,24 @@
21132339
},
21142340
"type": "object"
21152341
},
2342+
"GoogleFirebaseAppcheckV1betaListResourcePoliciesResponse": {
2343+
"description": "Response message for the ListResourcePolicies method.",
2344+
"id": "GoogleFirebaseAppcheckV1betaListResourcePoliciesResponse",
2345+
"properties": {
2346+
"nextPageToken": {
2347+
"description": "If the result list is too large to fit in a single response, then a token is returned. If the string is empty or omitted, then this response is the last page of results. This token can be used in a subsequent call to ListResourcePolicies to find the next group of ResourcePolicys. Page tokens are short-lived and should not be persisted.",
2348+
"type": "string"
2349+
},
2350+
"resourcePolicies": {
2351+
"description": "The ResourcePolicys retrieved.",
2352+
"items": {
2353+
"$ref": "GoogleFirebaseAppcheckV1betaResourcePolicy"
2354+
},
2355+
"type": "array"
2356+
}
2357+
},
2358+
"type": "object"
2359+
},
21162360
"GoogleFirebaseAppcheckV1betaListServicesResponse": {
21172361
"description": "Response message for the ListServices method.",
21182362
"id": "GoogleFirebaseAppcheckV1betaListServicesResponse",
@@ -2263,6 +2507,45 @@
22632507
},
22642508
"type": "object"
22652509
},
2510+
"GoogleFirebaseAppcheckV1betaResourcePolicy": {
2511+
"description": "App Check enforcement policy for a specific resource of a Firebase service supported by App Check. Note that this policy will override the Service level enforcement mode configuration.",
2512+
"id": "GoogleFirebaseAppcheckV1betaResourcePolicy",
2513+
"properties": {
2514+
"enforcementMode": {
2515+
"description": "Required. The App Check enforcement mode for this resource. This will override the EnforcementMode setting on the service. For new resources that you are creating, you should consider setting an override and enable enforcement on the resource immediately, if there are no outdated clients that can use it.",
2516+
"enum": [
2517+
"OFF",
2518+
"UNENFORCED",
2519+
"ENFORCED"
2520+
],
2521+
"enumDescriptions": [
2522+
"Firebase App Check is not enforced for the service, nor are App Check metrics collected. Though the service is not protected by App Check in this mode, other applicable protections, such as user authorization, are still enforced. An unconfigured service is in this mode by default. Note that resource policies behave slightly differently as an unconfigured resource policy means that the resource will inherit the EnforcementMode configured for the service it belongs to and will not be considered as being in OFF mode by default.",
2523+
"Firebase App Check is not enforced for the service. App Check metrics are collected to help you decide when to turn on enforcement for the service. Though the service is not protected by App Check in this mode, other applicable protections, such as user authorization, are still enforced. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `UNENFORCED` setting will have no effect and App Check will not work with that service.",
2524+
"Firebase App Check is enforced for the service. The service will reject any request that attempts to access your project's resources if it does not have valid App Check token attached, with some exceptions depending on the service; for example, some services will still allow requests bearing the developer's privileged service account credentials without an App Check token. App Check metrics continue to be collected to help you detect issues with your App Check integration and monitor the composition of your callers. While the service is protected by App Check, other applicable protections, such as user authorization, continue to be enforced at the same time. Use caution when choosing to enforce App Check on a Firebase service. If your users have not updated to an App Check capable version of your app, their apps will no longer be able to use your Firebase services that are enforcing App Check. App Check metrics can help you decide whether to enforce App Check on your Firebase services. If your app has not launched yet, you should enable enforcement immediately, since there are no outdated clients in use. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `ENFORCED` setting will have no effect and App Check will not work with that service."
2525+
],
2526+
"type": "string"
2527+
},
2528+
"etag": {
2529+
"description": "This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated.",
2530+
"type": "string"
2531+
},
2532+
"name": {
2533+
"description": "Required. The relative name of the resource configuration object, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID used as the resource ID for the policy.",
2534+
"type": "string"
2535+
},
2536+
"targetResource": {
2537+
"description": "Required. Service specific name of the resource object to which this policy applies, in the format: * `//oauth2.googleapis.com/projects/{project}/oauthClients/{oauth_client_id}` (Google Identity for iOS) NOTE that the resource must belong to the service specified in the `name` and be from the same project as this policy, but it may or may not exist at the time of creation of the policy.",
2538+
"type": "string"
2539+
},
2540+
"updateTime": {
2541+
"description": "Output only. Timestamp when this service configuration object was most recently updated.",
2542+
"format": "google-datetime",
2543+
"readOnly": true,
2544+
"type": "string"
2545+
}
2546+
},
2547+
"type": "object"
2548+
},
22662549
"GoogleFirebaseAppcheckV1betaSafetyNetConfig": {
22672550
"deprecated": true,
22682551
"description": "An app's SafetyNet configuration object. This configuration controls certain properties of the `AppCheckToken` returned by ExchangeSafetyNetToken, such as its ttl. Note that your registered SHA-256 certificate fingerprints are used to validate tokens issued by SafetyNet; please register them via the Firebase Console or programmatically via the [Firebase Management Service](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.androidApps.sha/create).",
@@ -2315,6 +2598,22 @@
23152598
},
23162599
"type": "object"
23172600
},
2601+
"GoogleFirebaseAppcheckV1betaUpdateResourcePolicyRequest": {
2602+
"description": "Request message for the UpdateResourcePolicy method as well as an individual update message for the BatchUpdateResourcePolicies method.",
2603+
"id": "GoogleFirebaseAppcheckV1betaUpdateResourcePolicyRequest",
2604+
"properties": {
2605+
"resourcePolicy": {
2606+
"$ref": "GoogleFirebaseAppcheckV1betaResourcePolicy",
2607+
"description": "Required. The ResourcePolicy to update. The ResourcePolicy's `name` field is used to identify the ResourcePolicy to be updated, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_name} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) Only the top-level resources are supported for each of the services. The resources must belong to the service specified and `resource_name` should be formatted as: * `oauthClients/{oauth_client_id}` (Google Identity for iOS)"
2608+
},
2609+
"updateMask": {
2610+
"description": "Required. A comma-separated list of names of fields in the ResourcePolicy to update. Example: `enforcement_mode`.",
2611+
"format": "google-fieldmask",
2612+
"type": "string"
2613+
}
2614+
},
2615+
"type": "object"
2616+
},
23182617
"GoogleFirebaseAppcheckV1betaUpdateServiceRequest": {
23192618
"description": "Request message for the UpdateService method as well as an individual update message for the BatchUpdateServices method.",
23202619
"id": "GoogleFirebaseAppcheckV1betaUpdateServiceRequest",

0 commit comments

Comments
 (0)
Please sign in to comment.