blob: ad5aabbd1a6c1a139397d13ac4085540b590b6ae [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="firebase_v1beta1.html">Firebase Management API</a> . <a href="firebase_v1beta1.projects.html">projects</a> . <a href="firebase_v1beta1.projects.androidApps.html">androidApps</a> . <a href="firebase_v1beta1.projects.androidApps.sha.html">sha</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Adds a SHA certificate to the specified AndroidApp.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Removes a SHA certificate from the specified AndroidApp.</p>
<p class="toc_element">
<code><a href="#list">list(parent, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the list of SHA-1 and SHA-256 certificates for the specified</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Adds a SHA certificate to the specified AndroidApp.
Args:
parent: string, The parent App to which a SHA certificate will be added, in the format:
&lt;br&gt;&lt;code&gt;projects/&lt;var&gt;PROJECT_NUMBER&lt;/var&gt;/androidApps/&lt;var&gt;APP_ID&lt;/var&gt;&lt;/code&gt;
&lt;br&gt;As an &lt;var&gt;APP_ID&lt;/var&gt; is a unique identifier, the Unique Resource
from Sub-Collection access pattern may be used here, in the format:
&lt;br&gt;&lt;code&gt;projects/-/androidApps/&lt;var&gt;APP_ID&lt;/var&gt;&lt;/code&gt; (required)
body: object, The request body.
The object takes the form of:
{ # A SHA-1 or SHA-256 certificate associated with the AndroidApp.
&quot;name&quot;: &quot;A String&quot;, # The fully qualified resource name of the `sha-key`, in the format:
# &lt;br&gt;&lt;code&gt;projects/&lt;var&gt;PROJECT_NUMBER&lt;/var&gt;/androidApps/&lt;var&gt;APP_ID&lt;/var&gt;/sha/&lt;var&gt;SHA_ID&lt;/var&gt;&lt;/code&gt;
&quot;certType&quot;: &quot;A String&quot;, # The SHA certificate type.
&quot;shaHash&quot;: &quot;A String&quot;, # The certificate hash for the App.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A SHA-1 or SHA-256 certificate associated with the AndroidApp.
&quot;name&quot;: &quot;A String&quot;, # The fully qualified resource name of the `sha-key`, in the format:
# &lt;br&gt;&lt;code&gt;projects/&lt;var&gt;PROJECT_NUMBER&lt;/var&gt;/androidApps/&lt;var&gt;APP_ID&lt;/var&gt;/sha/&lt;var&gt;SHA_ID&lt;/var&gt;&lt;/code&gt;
&quot;certType&quot;: &quot;A String&quot;, # The SHA certificate type.
&quot;shaHash&quot;: &quot;A String&quot;, # The certificate hash for the App.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Removes a SHA certificate from the specified AndroidApp.
Args:
name: string, The fully qualified resource name of the `sha-key`, in the format:
&lt;br&gt;&lt;code&gt;projects/&lt;var&gt;PROJECT_NUMBER&lt;/var&gt;/androidApps/&lt;var&gt;APP_ID&lt;/var&gt;/sha/&lt;var&gt;SHA_ID&lt;/var&gt;&lt;/code&gt;
&lt;br&gt;You can obtain the full name from the response of
[`ListShaCertificates`](../projects.androidApps.sha/list) or the original
[`CreateShaCertificate`](../projects.androidApps.sha/create). (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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);
# }
#
# The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, x__xgafv=None)</code>
<pre>Returns the list of SHA-1 and SHA-256 certificates for the specified
AndroidApp.
Args:
parent: string, The parent App for which to list SHA certificates, in the format:
&lt;br&gt;&lt;code&gt;projects/&lt;var&gt;PROJECT_NUMBER&lt;/var&gt;/androidApps/&lt;var&gt;APP_ID&lt;/var&gt;&lt;/code&gt;
&lt;br&gt;As an &lt;var&gt;APP_ID&lt;/var&gt; is a unique identifier, the Unique Resource
from Sub-Collection access pattern may be used here, in the format:
&lt;br&gt;&lt;code&gt;projects/-/androidApps/&lt;var&gt;APP_ID&lt;/var&gt;&lt;/code&gt; (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
&quot;certificates&quot;: [ # The list of SHA certificates associated with the App.
{ # A SHA-1 or SHA-256 certificate associated with the AndroidApp.
&quot;name&quot;: &quot;A String&quot;, # The fully qualified resource name of the `sha-key`, in the format:
# &lt;br&gt;&lt;code&gt;projects/&lt;var&gt;PROJECT_NUMBER&lt;/var&gt;/androidApps/&lt;var&gt;APP_ID&lt;/var&gt;/sha/&lt;var&gt;SHA_ID&lt;/var&gt;&lt;/code&gt;
&quot;certType&quot;: &quot;A String&quot;, # The SHA certificate type.
&quot;shaHash&quot;: &quot;A String&quot;, # The certificate hash for the App.
},
],
}</pre>
</div>
</body></html>