Skip to content

Commit

Permalink
chore(admin): update the api
Browse files Browse the repository at this point in the history
#### admin:directory_v1

The following keys were added:
- resources.users.methods.list.parameters.event (Total Keys: 5)

The following keys were changed:
- revision (Total Keys: 1)

#### admin:reports_v1

The following keys were changed:
- resources.activities.methods.list.parameters.applicationName (Total Keys: 1)
- resources.activities.methods.list.parameters.eventName (Total Keys: 1)
- resources.activities.methods.list.parameters.userKey (Total Keys: 1)
- resources.activities.methods.watch.parameters.applicationName (Total Keys: 1)
- resources.activities.methods.watch.parameters.eventName (Total Keys: 1)
- resources.activities.methods.watch.parameters.userKey (Total Keys: 1)
- resources.userUsageReport.methods.get.parameters.userKey (Total Keys: 1)
- revision (Total Keys: 1)
- schemas.Activity.properties.actor.properties.profileId (Total Keys: 1)
- schemas.Activity.properties.events.items.properties.name (Total Keys: 1)
- schemas.Activity.properties.events.items.properties.type (Total Keys: 1)
- schemas.Activity.properties.id.properties.customerId (Total Keys: 1)
- schemas.Activity.properties.ipAddress (Total Keys: 1)
- schemas.UsageReport.properties.entity.properties.profileId (Total Keys: 1)
  • Loading branch information
yoshi-automation committed Mar 3, 2021
1 parent b6dc1b9 commit 3fc3b76
Show file tree
Hide file tree
Showing 7 changed files with 69 additions and 40 deletions.
12 changes: 10 additions & 2 deletions docs/dyn/admin_directory_v1.users.html
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ <h2>Instance Methods</h2>
<code><a href="#insert">insert(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a user.</p>
<p class="toc_element">
<code><a href="#list">list(customFieldMask=None, customer=None, domain=None, maxResults=None, orderBy=None, pageToken=None, projection=None, query=None, showDeleted=None, sortOrder=None, viewType=None, x__xgafv=None)</a></code></p>
<code><a href="#list">list(customFieldMask=None, customer=None, domain=None, event=None, maxResults=None, orderBy=None, pageToken=None, projection=None, query=None, showDeleted=None, sortOrder=None, viewType=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a paginated list of either deleted users or all users in a domain.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
Expand Down Expand Up @@ -367,13 +367,21 @@ <h3>Method Details</h3>
</div>

<div class="method">
<code class="details" id="list">list(customFieldMask=None, customer=None, domain=None, maxResults=None, orderBy=None, pageToken=None, projection=None, query=None, showDeleted=None, sortOrder=None, viewType=None, x__xgafv=None)</code>
<code class="details" id="list">list(customFieldMask=None, customer=None, domain=None, event=None, maxResults=None, orderBy=None, pageToken=None, projection=None, query=None, showDeleted=None, sortOrder=None, viewType=None, x__xgafv=None)</code>
<pre>Retrieves a paginated list of either deleted users or all users in a domain.

Args:
customFieldMask: string, A comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when `projection=custom`.
customer: string, The unique ID for the customer&#x27;s Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, fill this field instead of domain. You can also use the `my_customer` alias to represent your account&#x27;s `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users). Either the `customer` or the `domain` parameter must be provided.
domain: string, The domain name. Use this field to get fields from only one domain. To return all domains for a customer account, use the `customer` query parameter instead. Either the `customer` or the `domain` parameter must be provided.
event: string, Event on which subscription is intended (if subscribing)
Allowed values
eventUndefined -
add - User Created Event
delete - User Deleted Event
makeAdmin - User Admin Status Change Event
undelete - User Undeleted Event
update - User Updated Event
maxResults: integer, Maximum number of results to return.
orderBy: string, Property to use for sorting results.
Allowed values
Expand Down
30 changes: 15 additions & 15 deletions docs/dyn/admin_reports_v1.activities.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/dyn/admin_reports_v1.customerUsageReports.html
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ <h3>Method Details</h3>
&quot;entity&quot;: { # Output only. Information about the type of the item.
&quot;customerId&quot;: &quot;A String&quot;, # Output only. The unique identifier of the customer&#x27;s account.
&quot;entityId&quot;: &quot;A String&quot;, # Output only. Object key. Only relevant if entity.type = &quot;OBJECT&quot; Note: external-facing name of report is &quot;Entities&quot; rather than &quot;Objects&quot;.
&quot;profileId&quot;: &quot;A String&quot;, # Output only. The user&#x27;s immutable G Suite profile identifier.
&quot;profileId&quot;: &quot;A String&quot;, # Output only. The user&#x27;s immutable Google Workspace profile identifier.
&quot;type&quot;: &quot;A String&quot;, # Output only. The type of item. The value is `user`.
&quot;userEmail&quot;: &quot;A String&quot;, # Output only. The user&#x27;s email address. Only relevant if entity.type = &quot;USER&quot;
},
Expand Down
2 changes: 1 addition & 1 deletion docs/dyn/admin_reports_v1.entityUsageReports.html
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ <h3>Method Details</h3>
&quot;entity&quot;: { # Output only. Information about the type of the item.
&quot;customerId&quot;: &quot;A String&quot;, # Output only. The unique identifier of the customer&#x27;s account.
&quot;entityId&quot;: &quot;A String&quot;, # Output only. Object key. Only relevant if entity.type = &quot;OBJECT&quot; Note: external-facing name of report is &quot;Entities&quot; rather than &quot;Objects&quot;.
&quot;profileId&quot;: &quot;A String&quot;, # Output only. The user&#x27;s immutable G Suite profile identifier.
&quot;profileId&quot;: &quot;A String&quot;, # Output only. The user&#x27;s immutable Google Workspace profile identifier.
&quot;type&quot;: &quot;A String&quot;, # Output only. The type of item. The value is `user`.
&quot;userEmail&quot;: &quot;A String&quot;, # Output only. The user&#x27;s email address. Only relevant if entity.type = &quot;USER&quot;
},
Expand Down
4 changes: 2 additions & 2 deletions docs/dyn/admin_reports_v1.userUsageReport.html
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ <h3>Method Details</h3>
<pre>Retrieves a report which is a collection of properties and statistics for a set of users with the account. For more information, see the User Usage Report guide. For more information about the user report&#x27;s parameters, see the Users Usage parameters reference guides.

Args:
userKey: string, Represents the profile ID or the user email for which the data should be filtered. Can be `all` for all information, or `userKey` for a user&#x27;s unique G Suite profile ID or their primary email address. (required)
userKey: string, Represents the profile ID or the user email for which the data should be filtered. Can be `all` for all information, or `userKey` for a user&#x27;s unique Google Workspace profile ID or their primary email address. (required)
date: string, Represents the date the usage occurred. The timestamp is in the ISO 8601 format, yyyy-mm-dd. We recommend you use your account&#x27;s time zone for this. (required)
customerId: string, The unique ID of the customer to retrieve data for.
filters: string, The `filters` query string is a comma-separated list of an application&#x27;s event parameters where the parameter&#x27;s value is manipulated by a relational operator. The `filters` query string includes the name of the application whose usage is returned in the report. The application values for the Users Usage Report include `accounts`, `docs`, and `gmail`. Filters are in the form `[application name]:parameter name[parameter value],...`. In this example, the `&lt;&gt;` &#x27;not equal to&#x27; operator is URL-encoded in the request&#x27;s query string (%3C%3E): GET https://www.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03 ?parameters=accounts:last_login_time &amp;filters=accounts:last_login_time%3C%3E2010-10-28T10:26:35.000Z The relational operators include: - `==` - &#x27;equal to&#x27;. - `&lt;&gt;` - &#x27;not equal to&#x27;. It is URL-encoded (%3C%3E). - `&lt;` - &#x27;less than&#x27;. It is URL-encoded (%3C). - `&lt;=` - &#x27;less than or equal to&#x27;. It is URL-encoded (%3C=). - `&gt;` - &#x27;greater than&#x27;. It is URL-encoded (%3E). - `&gt;=` - &#x27;greater than or equal to&#x27;. It is URL-encoded (%3E=).
Expand All @@ -121,7 +121,7 @@ <h3>Method Details</h3>
&quot;entity&quot;: { # Output only. Information about the type of the item.
&quot;customerId&quot;: &quot;A String&quot;, # Output only. The unique identifier of the customer&#x27;s account.
&quot;entityId&quot;: &quot;A String&quot;, # Output only. Object key. Only relevant if entity.type = &quot;OBJECT&quot; Note: external-facing name of report is &quot;Entities&quot; rather than &quot;Objects&quot;.
&quot;profileId&quot;: &quot;A String&quot;, # Output only. The user&#x27;s immutable G Suite profile identifier.
&quot;profileId&quot;: &quot;A String&quot;, # Output only. The user&#x27;s immutable Google Workspace profile identifier.
&quot;type&quot;: &quot;A String&quot;, # Output only. The type of item. The value is `user`.
&quot;userEmail&quot;: &quot;A String&quot;, # Output only. The user&#x27;s email address. Only relevant if entity.type = &quot;USER&quot;
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3478,6 +3478,27 @@
"location": "query",
"type": "string"
},
"event": {
"description": "Event on which subscription is intended (if subscribing)",
"enum": [
"eventUndefined",
"add",
"delete",
"makeAdmin",
"undelete",
"update"
],
"enumDescriptions": [
"",
"User Created Event",
"User Deleted Event",
"User Admin Status Change Event",
"User Undeleted Event",
"User Updated Event"
],
"location": "query",
"type": "string"
},
"maxResults": {
"default": "100",
"description": "Maximum number of results to return.",
Expand Down Expand Up @@ -4159,7 +4180,7 @@
}
}
},
"revision": "20210223",
"revision": "20210302",
"rootUrl": "https://admin.googleapis.com/",
"schemas": {
"Alias": {
Expand Down

0 comments on commit 3fc3b76

Please sign in to comment.