Skip to content

Commit

Permalink
feat(chromepolicy): update the api
Browse files Browse the repository at this point in the history
#### chromepolicy:v1

The following keys were deleted:
- schemas.GoogleChromePolicyV1AdditionalTargetKeyName (Total Keys: 3)
- schemas.GoogleChromePolicyV1ListPolicySchemasResponse (Total Keys: 5)
- schemas.GoogleChromePolicyV1PolicySchema (Total Keys: 33)

The following keys were added:
- resources.customers.resources.policies.resources.networks.methods.defineCertificate (Total Keys: 12)
- resources.customers.resources.policies.resources.networks.methods.defineNetwork (Total Keys: 12)
- resources.customers.resources.policies.resources.networks.methods.removeCertificate (Total Keys: 12)
- resources.customers.resources.policies.resources.networks.methods.removeNetwork (Total Keys: 12)
- schemas.GoogleChromePolicyV1DefineCertificateRequest (Total Keys: 7)
- schemas.GoogleChromePolicyV1DefineCertificateResponse (Total Keys: 6)
- schemas.GoogleChromePolicyV1DefineNetworkRequest (Total Keys: 6)
- schemas.GoogleChromePolicyV1DefineNetworkResponse (Total Keys: 6)
- schemas.GoogleChromePolicyV1NetworkSetting (Total Keys: 5)
- schemas.GoogleChromePolicyV1PolicyModificationFieldError (Total Keys: 6)
- schemas.GoogleChromePolicyV1RemoveCertificateRequest (Total Keys: 4)
- schemas.GoogleChromePolicyV1RemoveCertificateResponse (Total Keys: 2)
- schemas.GoogleChromePolicyV1RemoveNetworkRequest (Total Keys: 4)
- schemas.GoogleChromePolicyV1RemoveNetworkResponse (Total Keys: 2)
- schemas.GoogleChromePolicyVersionsV1AdditionalTargetKeyName (Total Keys: 3)
- schemas.GoogleChromePolicyVersionsV1ListPolicySchemasResponse (Total Keys: 5)
- schemas.GoogleChromePolicyVersionsV1PolicySchema (Total Keys: 33)

The following keys were changed:
- resources.customers.resources.policySchemas.methods.get.response.$ref (Total Keys: 1)
- resources.customers.resources.policySchemas.methods.list.response.$ref (Total Keys: 1)
  • Loading branch information
yoshi-automation committed Oct 4, 2022
1 parent ec3508a commit f247869
Show file tree
Hide file tree
Showing 5 changed files with 735 additions and 199 deletions.
7 changes: 6 additions & 1 deletion docs/dyn/chromepolicy_v1.customers.policies.html
Expand Up @@ -79,6 +79,11 @@ <h2>Instance Methods</h2>
</p>
<p class="firstline">Returns the groups Resource.</p>

<p class="toc_element">
<code><a href="chromepolicy_v1.customers.policies.networks.html">networks()</a></code>
</p>
<p class="firstline">Returns the networks Resource.</p>

<p class="toc_element">
<code><a href="chromepolicy_v1.customers.policies.orgunits.html">orgunits()</a></code>
</p>
Expand Down Expand Up @@ -111,7 +116,7 @@ <h3>Method Details</h3>
{ # Request message for getting the resolved policy value for a specific target.
&quot;pageSize&quot;: 42, # The maximum number of policies to return, defaults to 100 and has a maximum of 1000.
&quot;pageToken&quot;: &quot;A String&quot;, # The page token used to retrieve a specific page of the request.
&quot;policySchemaFilter&quot;: &quot;A String&quot;, # The schema filter to apply to the resolve request. Specify a schema name to view a particular schema, for example: chrome.users.ShowLogoutButton Wildcards are supported, but only in the leaf portion of the schema name. Wildcards cannot be used in namespace directly. Please read https://developers.google.com/chrome/policy/guides/policy-schemas for details on schema namepsaces. For example: Valid: &quot;chrome.users.*&quot;, &quot;chrome.users.apps.*&quot;, &quot;chrome.printers.*&quot; Invalid: &quot;*&quot;, &quot;*.users&quot;, &quot;chrome.*&quot;, &quot;chrome.*.apps.*&quot;
&quot;policySchemaFilter&quot;: &quot;A String&quot;, # The schema filter to apply to the resolve request. Specify a schema name to view a particular schema, for example: chrome.users.ShowLogoutButton Wildcards are supported, but only in the leaf portion of the schema name. Wildcards cannot be used in namespace directly. Please read https://developers.google.com/chrome/policy/guides/policy-schemas for details on schema namespaces. For example: Valid: &quot;chrome.users.*&quot;, &quot;chrome.users.apps.*&quot;, &quot;chrome.printers.*&quot; Invalid: &quot;*&quot;, &quot;*.users&quot;, &quot;chrome.*&quot;, &quot;chrome.*.apps.*&quot;
&quot;policyTargetKey&quot;: { # The key used to identify the target on which the policy will be applied. # Required. The key of the target resource on which the policies should be resolved. The target resource must point to an Org Unit.
&quot;additionalTargetKeys&quot;: { # Map containing the additional target key name and value pairs used to further identify the target of the policy.
&quot;a_key&quot;: &quot;A String&quot;,
Expand Down
239 changes: 239 additions & 0 deletions docs/dyn/chromepolicy_v1.customers.policies.networks.html
@@ -0,0 +1,239 @@
<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>
16 changes: 9 additions & 7 deletions docs/dyn/chromepolicy_v1.customers.policySchemas.html
Expand Up @@ -106,7 +106,7 @@ <h3>Method Details</h3>
Returns:
An object of the form:

{ # Resource representing a policy schema. Next ID: 14
{ # Resource representing a policy schema.
&quot;accessRestrictions&quot;: [ # Output only. Specific access restrictions related to this policy.
&quot;A String&quot;,
],
Expand All @@ -116,7 +116,7 @@ <h3>Method Details</h3>
&quot;keyDescription&quot;: &quot;A String&quot;, # Key description.
},
],
&quot;categoryTitle&quot;: &quot;A String&quot;, # Output only. Title of the category in which a setting belongs.
&quot;categoryTitle&quot;: &quot;A String&quot;, # Title of the category in which a setting belongs.
&quot;definition&quot;: { # Describes a complete .proto file. # Schema definition using proto descriptor.
&quot;enumType&quot;: [
{ # Describes an enum type.
Expand Down Expand Up @@ -172,6 +172,7 @@ <h3>Method Details</h3>
},
&quot;fieldDescriptions&quot;: [ # Output only. Detailed description of each field that is part of the schema.
{ # Provides detailed information for a particular field that is part of a PolicySchema.
&quot;defaultValue&quot;: &quot;&quot;, # Output only. Client default if the policy is unset.
&quot;description&quot;: &quot;A String&quot;, # Deprecated. Use name and field_description instead. The description for the field.
&quot;field&quot;: &quot;A String&quot;, # Output only. The name of the field for associated with this description.
&quot;fieldDependencies&quot;: [ # Output only. Provides a list of fields and values. At least one of the fields must have the corresponding value in order for this field to be allowed to be set.
Expand All @@ -190,7 +191,7 @@ <h3>Method Details</h3>
],
&quot;name&quot;: &quot;A String&quot;, # Output only. The name of the field.
&quot;nestedFieldDescriptions&quot;: [ # Output only. Provides the description of the fields nested in this field, if the field is a message type that defines multiple fields.
# Object with schema name: GoogleChromePolicyV1PolicySchemaFieldDescription
# Object with schema name: GoogleChromePolicyVersionsV1PolicySchemaFieldDescription
],
&quot;requiredItems&quot;: [ # Output only. Provides a list of fields that are required to be set if this field has a certain value.
{ # The fields that will become required based on the value of this field.
Expand Down Expand Up @@ -247,7 +248,7 @@ <h3>Method Details</h3>
Args:
parent: string, Required. The customer for which the listing request will apply. (required)
filter: string, The schema filter used to find a particular schema based on fields like its resource name, description and `additionalTargetKeyNames`.
pageSize: integer, The maximum number of policy schemas to return.
pageSize: integer, The maximum number of policy schemas to return, defaults to 100 and has a maximum of 1000.
pageToken: string, The page token used to retrieve a specific page of the listing request.
x__xgafv: string, V1 error format.
Allowed values
Expand All @@ -260,7 +261,7 @@ <h3>Method Details</h3>
{ # Response message for listing policy schemas that match a filter.
&quot;nextPageToken&quot;: &quot;A String&quot;, # The page token used to get the next page of policy schemas.
&quot;policySchemas&quot;: [ # The list of policy schemas that match the query.
{ # Resource representing a policy schema. Next ID: 14
{ # Resource representing a policy schema.
&quot;accessRestrictions&quot;: [ # Output only. Specific access restrictions related to this policy.
&quot;A String&quot;,
],
Expand All @@ -270,7 +271,7 @@ <h3>Method Details</h3>
&quot;keyDescription&quot;: &quot;A String&quot;, # Key description.
},
],
&quot;categoryTitle&quot;: &quot;A String&quot;, # Output only. Title of the category in which a setting belongs.
&quot;categoryTitle&quot;: &quot;A String&quot;, # Title of the category in which a setting belongs.
&quot;definition&quot;: { # Describes a complete .proto file. # Schema definition using proto descriptor.
&quot;enumType&quot;: [
{ # Describes an enum type.
Expand Down Expand Up @@ -326,6 +327,7 @@ <h3>Method Details</h3>
},
&quot;fieldDescriptions&quot;: [ # Output only. Detailed description of each field that is part of the schema.
{ # Provides detailed information for a particular field that is part of a PolicySchema.
&quot;defaultValue&quot;: &quot;&quot;, # Output only. Client default if the policy is unset.
&quot;description&quot;: &quot;A String&quot;, # Deprecated. Use name and field_description instead. The description for the field.
&quot;field&quot;: &quot;A String&quot;, # Output only. The name of the field for associated with this description.
&quot;fieldDependencies&quot;: [ # Output only. Provides a list of fields and values. At least one of the fields must have the corresponding value in order for this field to be allowed to be set.
Expand All @@ -344,7 +346,7 @@ <h3>Method Details</h3>
],
&quot;name&quot;: &quot;A String&quot;, # Output only. The name of the field.
&quot;nestedFieldDescriptions&quot;: [ # Output only. Provides the description of the fields nested in this field, if the field is a message type that defines multiple fields.
# Object with schema name: GoogleChromePolicyV1PolicySchemaFieldDescription
# Object with schema name: GoogleChromePolicyVersionsV1PolicySchemaFieldDescription
],
&quot;requiredItems&quot;: [ # Output only. Provides a list of fields that are required to be set if this field has a certain value.
{ # The fields that will become required based on the value of this field.
Expand Down
4 changes: 2 additions & 2 deletions docs/dyn/chromepolicy_v1.media.html
Expand Up @@ -95,7 +95,7 @@ <h3>Method Details</h3>
body: object, The request body.
The object takes the form of:

{ # Request message for uploading a file for a policy. Next ID: 5
{ # Request message for uploading a file for a policy.
&quot;policyField&quot;: &quot;A String&quot;, # Required. The fully qualified policy schema and field name this file is uploaded for. This information will be used to validate the content type of the file.
}

Expand All @@ -109,7 +109,7 @@ <h3>Method Details</h3>
Returns:
An object of the form:

{ # Response message for downloading an uploaded file. Next ID: 2
{ # Response message for downloading an uploaded file.
&quot;downloadUri&quot;: &quot;A String&quot;, # The uri for end user to download the file.
}</pre>
</div>
Expand Down

0 comments on commit f247869

Please sign in to comment.