blob: 7d0b9f4001f1e8c680945680d8681af745ac879d [file] [edit]
<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="chromepolicy_v1.html">Chrome Policy API</a> . <a href="chromepolicy_v1.customers.html">customers</a> . <a href="chromepolicy_v1.customers.policies.html">policies</a> . <a href="chromepolicy_v1.customers.policies.networks.html">networks</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#defineCertificate">defineCertificate(customer, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a certificate at a specified OU for a customer.</p>
<p class="toc_element">
<code><a href="#defineNetwork">defineNetwork(customer, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Define a new network.</p>
<p class="toc_element">
<code><a href="#removeCertificate">removeCertificate(customer, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Remove an existing certificate by guid.</p>
<p class="toc_element">
<code><a href="#removeNetwork">removeNetwork(customer, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Remove an existing network by guid.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="defineCertificate">defineCertificate(customer, body=None, x__xgafv=None)</code>
<pre>Creates a certificate at a specified OU for a customer.
Args:
customer: string, Required. The customer for which the certificate will apply. (required)
body: object, The request body.
The object takes the form of:
{ # Request object for creating a certificate.
&quot;ceritificateName&quot;: &quot;A String&quot;, # Optional. The optional name of the certificate. If not specified, the certificate issuer will be used as the name.
&quot;certificate&quot;: &quot;A String&quot;, # Required. The raw contents of the .PEM, .CRT, or .CER file.
&quot;settings&quot;: [ # Optional. Certificate settings within the chrome.networks.certificates namespace.
{ # A network setting contains network configurations.
&quot;policySchema&quot;: &quot;A String&quot;, # The fully qualified name of the network setting.
&quot;value&quot;: { # The value of the network setting.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
},
],
&quot;targetResource&quot;: &quot;A String&quot;, # Required. The target resource on which this certificate is applied. The following resources are supported: * Organizational Unit (&quot;orgunits/{orgunit_id}&quot;)
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response object for creating a certificate.
&quot;networkId&quot;: &quot;A String&quot;, # The guid of the certificate created by the action.
&quot;settings&quot;: [ # the affiliated settings of the certificate (NOT IMPLEMENTED)
{ # A network setting contains network configurations.
&quot;policySchema&quot;: &quot;A String&quot;, # The fully qualified name of the network setting.
&quot;value&quot;: { # The value of the network setting.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
},
],
&quot;targetResource&quot;: &quot;A String&quot;, # the resource at which the certificate is defined.
}</pre>
</div>
<div class="method">
<code class="details" id="defineNetwork">defineNetwork(customer, body=None, x__xgafv=None)</code>
<pre>Define a new network.
Args:
customer: string, Required. The customer who will own this new network. (required)
body: object, The request body.
The object takes the form of:
{ # Request object for creating a new network.
&quot;name&quot;: &quot;A String&quot;, # Required. Name of the new created network.
&quot;settings&quot;: [ # Required. Detailed network settings.
{ # A network setting contains network configurations.
&quot;policySchema&quot;: &quot;A String&quot;, # The fully qualified name of the network setting.
&quot;value&quot;: { # The value of the network setting.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
},
],
&quot;targetResource&quot;: &quot;A String&quot;, # Required. The target resource on which this new network will be defined. The following resources are supported: * Organizational Unit (&quot;orgunits/{orgunit_id}&quot;)
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response object for creating a network.
&quot;networkId&quot;: &quot;A String&quot;, # Network ID of the new created network.
&quot;settings&quot;: [ # Detailed network settings of the new created network
{ # A network setting contains network configurations.
&quot;policySchema&quot;: &quot;A String&quot;, # The fully qualified name of the network setting.
&quot;value&quot;: { # The value of the network setting.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
},
],
&quot;targetResource&quot;: &quot;A String&quot;, # The target resource on which this new network will be defined. The following resources are supported: * Organizational Unit (&quot;orgunits/{orgunit_id}&quot;)
}</pre>
</div>
<div class="method">
<code class="details" id="removeCertificate">removeCertificate(customer, body=None, x__xgafv=None)</code>
<pre>Remove an existing certificate by guid.
Args:
customer: string, Required. The customer whose certificate will be removed. (required)
body: object, The request body.
The object takes the form of:
{ # Request object for removing a certificate.
&quot;networkId&quot;: &quot;A String&quot;, # Required. The GUID of the certificate to remove.
&quot;targetResource&quot;: &quot;A String&quot;, # Required. The target resource on which this certificate will be removed. The following resources are supported: * Organizational Unit (&quot;orgunits/{orgunit_id}&quot;)
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response object for removing a certificate.
}</pre>
</div>
<div class="method">
<code class="details" id="removeNetwork">removeNetwork(customer, body=None, x__xgafv=None)</code>
<pre>Remove an existing network by guid.
Args:
customer: string, Required. The customer whose network will be removed. (required)
body: object, The request body.
The object takes the form of:
{ # Request object for removing a network
&quot;networkId&quot;: &quot;A String&quot;, # Required. The GUID of the network to remove.
&quot;targetResource&quot;: &quot;A String&quot;, # Required. The target resource on which this network will be removed. The following resources are supported: * Organizational Unit (&quot;orgunits/{orgunit_id}&quot;)
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response object for removing a network.
}</pre>
</div>
</body></html>