Skip to content

Commit

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

The following keys were added:
- resources.policies.methods.get (Total Keys: 11)
- resources.policies.methods.list (Total Keys: 14)
- schemas.ListPoliciesResponse (Total Keys: 5)
- schemas.Policy (Total Keys: 17)
- schemas.Setting (Total Keys: 5)
  • Loading branch information
yoshi-automation committed Dec 17, 2024
1 parent 2c59d35 commit 8611287
Show file tree
Hide file tree
Showing 4 changed files with 359 additions and 2 deletions.
5 changes: 5 additions & 0 deletions docs/dyn/cloudidentity_v1.html
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,11 @@ <h2>Instance Methods</h2>
</p>
<p class="firstline">Returns the inboundSsoAssignments Resource.</p>

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

<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
Expand Down
182 changes: 182 additions & 0 deletions docs/dyn/cloudidentity_v1.policies.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,182 @@
<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="cloudidentity_v1.html">Cloud Identity API</a> . <a href="cloudidentity_v1.policies.html">policies</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="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get a Policy</p>
<p class="toc_element">
<code><a href="#list">list(filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List Policies</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</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="get">get(name, x__xgafv=None)</code>
<pre>Get a Policy

Args:
name: string, Required. The name of the policy to retrieve. Format: &quot;policies/{policy}&quot;. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # A Policy resource binds an instance of a single Setting with the scope of a PolicyQuery. The Setting instance will be applied to all entities that satisfy the query.
&quot;customer&quot;: &quot;A String&quot;, # Immutable. Customer that the Policy belongs to. The value is in the format &#x27;customers/{customerId}&#x27;. The `customerId` must begin with &quot;C&quot; To find your customer ID in Admin Console see https://support.google.com/a/answer/10070793.
&quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The [resource name](https://cloud.google.com/apis/design/resource_names) of the Policy. Format: policies/{policy}.
&quot;policyQuery&quot;: { # PolicyQuery # Required. The PolicyQuery the Setting applies to.
&quot;group&quot;: &quot;A String&quot;, # Immutable. The group that the query applies to. This field is only set if there is a single value for group that satisfies all clauses of the query. If no group applies, this will be the empty string.
&quot;orgUnit&quot;: &quot;A String&quot;, # Required. Immutable. Non-empty default. The OrgUnit the query applies to. This field is only set if there is a single value for org_unit that satisfies all clauses of the query.
&quot;query&quot;: &quot;A String&quot;, # Immutable. The CEL query that defines which entities the Policy applies to (ex. a User entity). For details about CEL see https://opensource.google.com/projects/cel. The OrgUnits the Policy applies to are represented by a clause like so: entity.org_units.exists(org_unit, org_unit.org_unit_id == orgUnitId(&#x27;{orgUnitId}&#x27;)) The Group the Policy applies to are represented by a clause like so: entity.groups.exists(group, group.group_id == groupId(&#x27;{groupId}&#x27;)) The Licenses the Policy applies to are represented by a clause like so: entity.licenses.exists(license, license in [&#x27;/product/{productId}/sku/{skuId}&#x27;]) The above clauses can be present in any combination, and used in conjunction with the &amp;&amp;, || and ! operators. The org_unit and group fields below are helper fields that contain the corresponding value(s) as the query to make the query easier to use.
&quot;sortOrder&quot;: 3.14, # Output only. The decimal sort order of this PolicyQuery. The value is relative to all other policies with the same setting type for the customer. (There are no duplicates within this set).
},
&quot;setting&quot;: { # Setting # Required. The Setting configured by this Policy.
&quot;type&quot;: &quot;A String&quot;, # Required. Immutable. The type of the Setting. .
&quot;value&quot;: { # Required. The value of the Setting.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
},
&quot;type&quot;: &quot;A String&quot;, # Output only. The type of the policy.
}</pre>
</div>

<div class="method">
<code class="details" id="list">list(filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>List Policies

Args:
filter: string, Optional. A CEL expression for filtering the results. Policies can be filtered by application with this expression: setting.name = &#x27;settings/gmail.*&#x27; Policies can be filtered by setting type with this expression: setting.name = &#x27;*.service_status&#x27; A maximum of one of the above setting.name clauses can be used. Policies can be filtered by customer with this expression: customer = &quot;customers/{customer}&quot; Where `customer` is the `id` from the [Admin SDK `Customer` resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). You may use `customers/my_customer` to specify your own organization. When no customer is mentioned it will be default to customers/my_customer. A maximum of one customer clause can be used. The above clauses can only be combined together in a single filter expression with the `&amp;&amp;` operator.
pageSize: integer, Optional. The maximum number of results to return. The service can return fewer than this number. If omitted or set to 0, the default is 50 results per page. The maximum allowed value is 100. `page_size` values greater than 100 default to 100.
pageToken: string, Optional. The pagination token received from a prior call to PoliciesService.ListPolicies to retrieve the next page of results. When paginating, all other parameters provided to `ListPoliciesRequest` must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # The response message for PoliciesService.ListPolicies.
&quot;nextPageToken&quot;: &quot;A String&quot;, # The pagination token to retrieve the next page of results. If this field is empty, there are no subsequent pages.
&quot;policies&quot;: [ # The results
{ # A Policy resource binds an instance of a single Setting with the scope of a PolicyQuery. The Setting instance will be applied to all entities that satisfy the query.
&quot;customer&quot;: &quot;A String&quot;, # Immutable. Customer that the Policy belongs to. The value is in the format &#x27;customers/{customerId}&#x27;. The `customerId` must begin with &quot;C&quot; To find your customer ID in Admin Console see https://support.google.com/a/answer/10070793.
&quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The [resource name](https://cloud.google.com/apis/design/resource_names) of the Policy. Format: policies/{policy}.
&quot;policyQuery&quot;: { # PolicyQuery # Required. The PolicyQuery the Setting applies to.
&quot;group&quot;: &quot;A String&quot;, # Immutable. The group that the query applies to. This field is only set if there is a single value for group that satisfies all clauses of the query. If no group applies, this will be the empty string.
&quot;orgUnit&quot;: &quot;A String&quot;, # Required. Immutable. Non-empty default. The OrgUnit the query applies to. This field is only set if there is a single value for org_unit that satisfies all clauses of the query.
&quot;query&quot;: &quot;A String&quot;, # Immutable. The CEL query that defines which entities the Policy applies to (ex. a User entity). For details about CEL see https://opensource.google.com/projects/cel. The OrgUnits the Policy applies to are represented by a clause like so: entity.org_units.exists(org_unit, org_unit.org_unit_id == orgUnitId(&#x27;{orgUnitId}&#x27;)) The Group the Policy applies to are represented by a clause like so: entity.groups.exists(group, group.group_id == groupId(&#x27;{groupId}&#x27;)) The Licenses the Policy applies to are represented by a clause like so: entity.licenses.exists(license, license in [&#x27;/product/{productId}/sku/{skuId}&#x27;]) The above clauses can be present in any combination, and used in conjunction with the &amp;&amp;, || and ! operators. The org_unit and group fields below are helper fields that contain the corresponding value(s) as the query to make the query easier to use.
&quot;sortOrder&quot;: 3.14, # Output only. The decimal sort order of this PolicyQuery. The value is relative to all other policies with the same setting type for the customer. (There are no duplicates within this set).
},
&quot;setting&quot;: { # Setting # Required. The Setting configured by this Policy.
&quot;type&quot;: &quot;A String&quot;, # Required. Immutable. The type of the Setting. .
&quot;value&quot;: { # Required. The value of the Setting.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
},
&quot;type&quot;: &quot;A String&quot;, # Output only. The type of the policy.
},
],
}</pre>
</div>

<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.

Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)

Returns:
A request object that you can call &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>

</body></html>
Loading

0 comments on commit 8611287

Please sign in to comment.