| 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.safetyNetConfig.html">safetyNetConfig</a></h1> |
| 76 |
<h2>Instance Methods</h2> |
| 77 |
<p class="toc_element"> |
| 78 |
<code><a href="#batchGet">batchGet(parent, names=None, x__xgafv=None)</a></code></p> |
| 79 |
<p class="firstline">Atomically gets the SafetyNetConfigs for the specified list of apps.</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="#get">get(name, x__xgafv=None)</a></code></p> |
| 85 |
<p class="firstline">Gets the SafetyNetConfig for the specified app.</p> |
| 86 |
<p class="toc_element"> |
| 87 |
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| 88 |
<p class="firstline">Updates the SafetyNetConfig for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange SafetyNet tokens for App Check tokens.</p> |
| 89 |
<h3>Method Details</h3> |
| 90 |
<div class="method"> |
| 91 |
<code class="details" id="batchGet">batchGet(parent, names=None, x__xgafv=None)</code> |
| 92 |
<pre>Atomically gets the SafetyNetConfigs for the specified list of apps. |
| 93 |
|
| 94 |
Args: |
| 95 |
parent: string, Required. The parent project name shared by all SafetyNetConfigs being retrieved, in the format ``` projects/{project_number} ``` The parent collection in the `name` field of any resource being retrieved must match this field, or the entire batch fails. (required) |
| 96 |
names: string, Required. The relative resource names of the SafetyNetConfigs to retrieve, in the format ``` projects/{project_number}/apps/{app_id}/safetyNetConfig ``` A maximum of 100 objects can be retrieved in a batch. (repeated) |
| 97 |
x__xgafv: string, V1 error format. |
| 98 |
Allowed values |
| 99 |
1 - v1 error format |
| 100 |
2 - v2 error format |
| 101 |
|
| 102 |
Returns: |
| 103 |
An object of the form: |
| 104 |
|
| 105 |
{ # Response message for the BatchGetSafetyNetConfigs method. |
| 106 |
"configs": [ # SafetyNetConfigs retrieved. |
| 107 |
{ # 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/v11/projects.androidApps.sha/create). |
| 108 |
"name": "A String", # Required. The relative resource name of the SafetyNet configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/safetyNetConfig ``` |
| 109 |
"tokenTtl": "A String", # Specifies the duration for which App Check tokens exchanged from SafetyNet tokens will be valid. If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive. |
| 110 |
}, |
| 111 |
], |
| 112 |
}</pre> |
| 113 |
</div> |
| 114 |
|
| 115 |
<div class="method"> |
| 116 |
<code class="details" id="close">close()</code> |
| 117 |
<pre>Close httplib2 connections.</pre> |
| 118 |
</div> |
| 119 |
|
| 120 |
<div class="method"> |
| 121 |
<code class="details" id="get">get(name, x__xgafv=None)</code> |
| 122 |
<pre>Gets the SafetyNetConfig for the specified app. |
| 123 |
|
| 124 |
Args: |
| 125 |
name: string, Required. The relative resource name of the SafetyNetConfig, in the format: ``` projects/{project_number}/apps/{app_id}/safetyNetConfig ``` (required) |
| 126 |
x__xgafv: string, V1 error format. |
| 127 |
Allowed values |
| 128 |
1 - v1 error format |
| 129 |
2 - v2 error format |
| 130 |
|
| 131 |
Returns: |
| 132 |
An object of the form: |
| 133 |
|
| 134 |
{ # 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/v11/projects.androidApps.sha/create). |
| 135 |
"name": "A String", # Required. The relative resource name of the SafetyNet configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/safetyNetConfig ``` |
| 136 |
"tokenTtl": "A String", # Specifies the duration for which App Check tokens exchanged from SafetyNet tokens will be valid. If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive. |
| 137 |
}</pre> |
| 138 |
</div> |
| 139 |
|
| 140 |
<div class="method"> |
| 141 |
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| 142 |
<pre>Updates the SafetyNetConfig for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange SafetyNet tokens for App Check tokens. |
| 143 |
|
| 144 |
Args: |
| 145 |
name: string, Required. The relative resource name of the SafetyNet configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/safetyNetConfig ``` (required) |
| 146 |
body: object, The request body. |
| 147 |
The object takes the form of: |
| 148 |
|
| 149 |
{ # 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/v11/projects.androidApps.sha/create). |
| 150 |
"name": "A String", # Required. The relative resource name of the SafetyNet configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/safetyNetConfig ``` |
| 151 |
"tokenTtl": "A String", # Specifies the duration for which App Check tokens exchanged from SafetyNet tokens will be valid. If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive. |
| 152 |
} |
| 153 |
|
| 154 |
updateMask: string, Required. A comma-separated list of names of fields in the SafetyNetConfig to update. Example: `token_ttl`. |
| 155 |
x__xgafv: string, V1 error format. |
| 156 |
Allowed values |
| 157 |
1 - v1 error format |
| 158 |
2 - v2 error format |
| 159 |
|
| 160 |
Returns: |
| 161 |
An object of the form: |
| 162 |
|
| 163 |
{ # 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/v11/projects.androidApps.sha/create). |
| 164 |
"name": "A String", # Required. The relative resource name of the SafetyNet configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/safetyNetConfig ``` |
| 165 |
"tokenTtl": "A String", # Specifies the duration for which App Check tokens exchanged from SafetyNet tokens will be valid. If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive. |
| 166 |
}</pre> |
| 167 |
</div> |
| 168 |
|
| 169 |
</body></html> |