Debian Codegraph @

docs/dyn/firebaseappcheck_v1.projects.apps.debugTokens.html

raw
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_v1.html">Firebase App Check API</a> . <a href="firebaseappcheck_v1.projects.html">projects</a> . <a href="firebaseappcheck_v1.projects.apps.html">apps</a> . <a href="firebaseappcheck_v1.projects.apps.debugTokens.html">debugTokens</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Creates a new DebugToken for the specified app. For security reasons, after the creation operation completes, the `token` field cannot be updated or retrieved, but you can revoke the debug token using DeleteDebugToken. Each app can have a maximum of 20 debug tokens.</p>
83 <p class="toc_element">
84 <code><a href="#delete">delete(name, etag=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Deletes the specified DebugToken. A deleted debug token cannot be used to exchange for an App Check token. Use this method when you suspect the secret `token` has been compromised or when you no longer need the debug token.</p>
86 <p class="toc_element">
87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
88 <p class="firstline">Gets the specified DebugToken. For security reasons, the `token` field is never populated in the response.</p>
89 <p class="toc_element">
90 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Lists all DebugTokens for the specified app. For security reasons, the `token` field is never populated in the response.</p>
92 <p class="toc_element">
93 <code><a href="#list_next">list_next()</a></code></p>
94 <p class="firstline">Retrieves the next page of results.</p>
95 <p class="toc_element">
96 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Updates the specified DebugToken. For security reasons, the `token` field cannot be updated, nor will it be populated in the response, but you can revoke the debug token using DeleteDebugToken.</p>
98 <h3>Method Details</h3>
99 <div class="method">
100 <code class="details" id="close">close()</code>
101 <pre>Close httplib2 connections.</pre>
102 </div>
103
104 <div class="method">
105 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
106 <pre>Creates a new DebugToken for the specified app. For security reasons, after the creation operation completes, the `token` field cannot be updated or retrieved, but you can revoke the debug token using DeleteDebugToken. Each app can have a maximum of 20 debug tokens.
107
108 Args:
109 parent: string, Required. The relative resource name of the parent app in which the specified DebugToken will be created, in the format: ``` projects/{project_number}/apps/{app_id} ``` (required)
110 body: object, The request body.
111 The object takes the form of:
112
113 { # A *debug token* is a secret used during the development or integration testing of an app. It essentially allows the development or integration testing to bypass app attestation while still allowing App Check to enforce protection on supported production Firebase services.
114 &quot;displayName&quot;: &quot;A String&quot;, # Required. A human readable display name used to identify this debug token.
115 &quot;etag&quot;: &quot;A String&quot;, # Optional. 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 as defined by RFC 7232.
116 &quot;name&quot;: &quot;A String&quot;, # Required. The relative resource name of the debug token, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ```
117 &quot;token&quot;: &quot;A String&quot;, # Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during an UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response.
118 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this debug token was most recently updated.
119 }
120
121 x__xgafv: string, V1 error format.
122 Allowed values
123 1 - v1 error format
124 2 - v2 error format
125
126 Returns:
127 An object of the form:
128
129 { # A *debug token* is a secret used during the development or integration testing of an app. It essentially allows the development or integration testing to bypass app attestation while still allowing App Check to enforce protection on supported production Firebase services.
130 &quot;displayName&quot;: &quot;A String&quot;, # Required. A human readable display name used to identify this debug token.
131 &quot;etag&quot;: &quot;A String&quot;, # Optional. 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 as defined by RFC 7232.
132 &quot;name&quot;: &quot;A String&quot;, # Required. The relative resource name of the debug token, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ```
133 &quot;token&quot;: &quot;A String&quot;, # Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during an UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response.
134 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this debug token was most recently updated.
135 }</pre>
136 </div>
137
138 <div class="method">
139 <code class="details" id="delete">delete(name, etag=None, x__xgafv=None)</code>
140 <pre>Deletes the specified DebugToken. A deleted debug token cannot be used to exchange for an App Check token. Use this method when you suspect the secret `token` has been compromised or when you no longer need the debug token.
141
142 Args:
143 name: string, Required. The relative resource name of the DebugToken to delete, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ``` (required)
144 etag: string, Optional. The checksum to be validated against the current DebugToken, to ensure the client has an up-to-date value before proceeding. This checksum is computed by the server based on the values of fields in the DebugToken object, and can be obtained from the DebugToken object received from the last CreateDebugToken, GetDebugToken, ListDebugTokens, or UpdateDebugToken call. This etag is strongly validated as defined by RFC 7232.
145 x__xgafv: string, V1 error format.
146 Allowed values
147 1 - v1 error format
148 2 - v2 error format
149
150 Returns:
151 An object of the form:
152
153 { # 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); }
154 }</pre>
155 </div>
156
157 <div class="method">
158 <code class="details" id="get">get(name, x__xgafv=None)</code>
159 <pre>Gets the specified DebugToken. For security reasons, the `token` field is never populated in the response.
160
161 Args:
162 name: string, Required. The relative resource name of the debug token, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ``` (required)
163 x__xgafv: string, V1 error format.
164 Allowed values
165 1 - v1 error format
166 2 - v2 error format
167
168 Returns:
169 An object of the form:
170
171 { # A *debug token* is a secret used during the development or integration testing of an app. It essentially allows the development or integration testing to bypass app attestation while still allowing App Check to enforce protection on supported production Firebase services.
172 &quot;displayName&quot;: &quot;A String&quot;, # Required. A human readable display name used to identify this debug token.
173 &quot;etag&quot;: &quot;A String&quot;, # Optional. 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 as defined by RFC 7232.
174 &quot;name&quot;: &quot;A String&quot;, # Required. The relative resource name of the debug token, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ```
175 &quot;token&quot;: &quot;A String&quot;, # Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during an UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response.
176 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this debug token was most recently updated.
177 }</pre>
178 </div>
179
180 <div class="method">
181 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
182 <pre>Lists all DebugTokens for the specified app. For security reasons, the `token` field is never populated in the response.
183
184 Args:
185 parent: string, Required. The relative resource name of the parent app for which to list each associated DebugToken, in the format: ``` projects/{project_number}/apps/{app_id} ``` (required)
186 pageSize: integer, The maximum number of DebugTokens to return in the response. Note that an app can have at most 20 debug tokens. 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.
187 pageToken: string, Token returned from a previous call to ListDebugTokens indicating where in the set of DebugTokens to resume listing. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDebugTokens must match the call that provided the page token; if they do not match, the result is undefined.
188 x__xgafv: string, V1 error format.
189 Allowed values
190 1 - v1 error format
191 2 - v2 error format
192
193 Returns:
194 An object of the form:
195
196 { # Response message for the ListDebugTokens method.
197 &quot;debugTokens&quot;: [ # The DebugTokens retrieved.
198 { # A *debug token* is a secret used during the development or integration testing of an app. It essentially allows the development or integration testing to bypass app attestation while still allowing App Check to enforce protection on supported production Firebase services.
199 &quot;displayName&quot;: &quot;A String&quot;, # Required. A human readable display name used to identify this debug token.
200 &quot;etag&quot;: &quot;A String&quot;, # Optional. 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 as defined by RFC 7232.
201 &quot;name&quot;: &quot;A String&quot;, # Required. The relative resource name of the debug token, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ```
202 &quot;token&quot;: &quot;A String&quot;, # Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during an UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response.
203 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this debug token was most recently updated.
204 },
205 ],
206 &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 ListDebugTokens to find the next group of DebugTokens. Page tokens are short-lived and should not be persisted.
207 }</pre>
208 </div>
209
210 <div class="method">
211 <code class="details" id="list_next">list_next()</code>
212 <pre>Retrieves the next page of results.
213
214 Args:
215 previous_request: The request for the previous page. (required)
216 previous_response: The response from the request for the previous page. (required)
217
218 Returns:
219 A request object that you can call &#x27;execute()&#x27; on to request the next
220 page. Returns None if there are no more items in the collection.
221 </pre>
222 </div>
223
224 <div class="method">
225 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
226 <pre>Updates the specified DebugToken. For security reasons, the `token` field cannot be updated, nor will it be populated in the response, but you can revoke the debug token using DeleteDebugToken.
227
228 Args:
229 name: string, Required. The relative resource name of the debug token, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ``` (required)
230 body: object, The request body.
231 The object takes the form of:
232
233 { # A *debug token* is a secret used during the development or integration testing of an app. It essentially allows the development or integration testing to bypass app attestation while still allowing App Check to enforce protection on supported production Firebase services.
234 &quot;displayName&quot;: &quot;A String&quot;, # Required. A human readable display name used to identify this debug token.
235 &quot;etag&quot;: &quot;A String&quot;, # Optional. 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 as defined by RFC 7232.
236 &quot;name&quot;: &quot;A String&quot;, # Required. The relative resource name of the debug token, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ```
237 &quot;token&quot;: &quot;A String&quot;, # Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during an UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response.
238 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this debug token was most recently updated.
239 }
240
241 updateMask: string, Required. A comma-separated list of names of fields in the DebugToken to update. Example: `display_name`.
242 x__xgafv: string, V1 error format.
243 Allowed values
244 1 - v1 error format
245 2 - v2 error format
246
247 Returns:
248 An object of the form:
249
250 { # A *debug token* is a secret used during the development or integration testing of an app. It essentially allows the development or integration testing to bypass app attestation while still allowing App Check to enforce protection on supported production Firebase services.
251 &quot;displayName&quot;: &quot;A String&quot;, # Required. A human readable display name used to identify this debug token.
252 &quot;etag&quot;: &quot;A String&quot;, # Optional. 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 as defined by RFC 7232.
253 &quot;name&quot;: &quot;A String&quot;, # Required. The relative resource name of the debug token, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ```
254 &quot;token&quot;: &quot;A String&quot;, # Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during an UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response.
255 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this debug token was most recently updated.
256 }</pre>
257 </div>
258
259 </body></html>