google_api_admin v0.18.0 API Reference

API client metadata for GoogleApi.Admin.Datatransfer_v1.

API calls for all endpoints tagged Applications.

API calls for all endpoints tagged Transfers.

Handle Tesla connections for GoogleApi.Admin.Datatransfer_v1.

The JSON template for an Application resource. STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)

Template to map fields of ApplicationDataTransfer resource.

Template for application transfer parameters.

Template for a collection of Applications. STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)

The JSON template for a DataTransfer resource. STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)

Template for a collection of DataTransfer resources. STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)

API client metadata for GoogleApi.Admin.Directory_v1.

API calls for all endpoints tagged Asps.

API calls for all endpoints tagged Channels.

API calls for all endpoints tagged Chromeosdevices.

API calls for all endpoints tagged Customers.

API calls for all endpoints tagged DomainAliases.

API calls for all endpoints tagged Domains.

API calls for all endpoints tagged Groups.

API calls for all endpoints tagged Members.

API calls for all endpoints tagged Mobiledevices.

API calls for all endpoints tagged Notifications.

API calls for all endpoints tagged Orgunits.

API calls for all endpoints tagged Privileges.

API calls for all endpoints tagged Resources.

API calls for all endpoints tagged RoleAssignments.

API calls for all endpoints tagged Roles.

API calls for all endpoints tagged Schemas.

API calls for all endpoints tagged Tokens.

API calls for all endpoints tagged Users.

API calls for all endpoints tagged VerificationCodes.

Handle Tesla connections for GoogleApi.Admin.Directory_v1.

JSON template for Alias object in Directory API.

JSON response template to list aliases in Directory API.

The template that returns individual ASP (Access Code) data.

Attributes

• etag (type: String.t, default: nil) - ETag of the resource.
• items (type: list(GoogleApi.Admin.Directory_v1.Model.Asp.t), default: nil) - A list of ASP resources.
• kind (type: String.t, default: admin#directory#aspList) - The type of the API resource. This is always admin#directory#aspList.

JSON template for Building object in Directory API.

JSON template for the postal address of a building in Directory API.

JSON template for coordinates of a building in Directory API.

JSON template for Building List Response object in Directory API.

JSON template for Calendar Resource object in Directory API.

JSON template for Calendar Resource List Response object in Directory API.

An notification channel used to watch for resource changes.

JSON template for Chrome Os Device resource in Directory API.

JSON request template for firing actions on ChromeOs Device in Directory Devices API.

Attributes

• activeTime (type: integer(), default: nil) - Duration in milliseconds
• date (type: Date.t, default: nil) - Date of usage

Attributes

• cpuTemperatureInfo (type: list(GoogleApi.Admin.Directory_v1.Model.ChromeOsDeviceCpuStatusReportsCpuTemperatureInfo.t), default: nil) - List of CPU temperature samples.
• cpuUtilizationPercentageInfo (type: list(integer()), default: nil) -
• reportTime (type: DateTime.t, default: nil) - Date and time the report was received.

Attributes

• label (type: String.t, default: nil) - CPU label
• temperature (type: integer(), default: nil) - Temperature in Celsius degrees.

Attributes

• createTime (type: DateTime.t, default: nil) - Date and time the file was created
• downloadUrl (type: String.t, default: nil) - File download URL
• name (type: String.t, default: nil) - File name
• type (type: String.t, default: nil) - File type

Attributes

• volumeInfo (type: list(GoogleApi.Admin.Directory_v1.Model.ChromeOsDeviceDiskVolumeReportsVolumeInfo.t), default: nil) - Disk volumes

Attributes

• storageFree (type: String.t, default: nil) - Free disk space [in bytes]
• storageTotal (type: String.t, default: nil) - Total disk space [in bytes]
• volumeId (type: String.t, default: nil) - Volume id

Attributes

• ipAddress (type: String.t, default: nil) - The IP address
• wanIpAddress (type: String.t, default: nil) - The WAN IP address

Attributes

• email (type: String.t, default: nil) - Email address of the user. Present only if the user type is managed
• type (type: String.t, default: nil) - The type of the user

Attributes

• reportTime (type: DateTime.t, default: nil) - Date and time the report was received.
• systemRamFreeInfo (type: list(String.t), default: nil) -

Trusted Platform Module (TPM) (Read-only)

JSON response template for List Chrome OS Devices operation in Directory API.

JSON request template for moving ChromeOs Device to given OU in Directory Devices API.

JSON template for Customer Resource object in Directory API.

JSON template for postal address of a customer.

JSON template for Domain Alias object in Directory API.

JSON response template to list domain aliases in Directory API.

JSON template for Domain object in Directory API.

JSON response template to list Domains in Directory API.

JSON template for Feature object in Directory API.

JSON template for a "feature instance".

JSON request template for renaming a feature.

JSON template for Feature List Response object in Directory API.

JSON template for Group resource in Directory API.

JSON response template for List Groups operation in Directory API.

JSON template for Member resource in Directory API.

JSON response template for List Members operation in Directory API.

JSON template for Has Member response in Directory API.

JSON template for Mobile Device resource in Directory API.

JSON request template for firing commands on Mobile Device in Directory Devices API.

Attributes

• displayName (type: String.t, default: nil) - Display name of application
• packageName (type: String.t, default: nil) - Package name of application
• permission (type: list(String.t), default: nil) - List of Permissions for application
• versionCode (type: integer(), default: nil) - Version code of application
• versionName (type: String.t, default: nil) - Version name of application

JSON response template for List Mobile Devices operation in Directory API.

Template for a notification resource.

Template for notifications list response.

JSON template for Org Unit resource in Directory API.

JSON response template for List Organization Units operation in Directory API.

JSON template for privilege resource in Directory API.

JSON response template for List privileges operation in Directory API.

JSON template for role resource in Directory API.

JSON template for roleAssignment resource in Directory API.

JSON response template for List roleAssignments operation in Directory API.

Attributes

• privilegeName (type: String.t, default: nil) - The name of the privilege.
• serviceId (type: String.t, default: nil) - The obfuscated ID of the service this privilege is for. This value is returned with Privileges.list().

JSON response template for List roles operation in Directory API.

JSON template for Schema resource in Directory API.

JSON template for FieldSpec resource for Schemas in Directory API.

Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported.

JSON response template for List Schema operation in Directory API.

JSON template for token resource in Directory API.

JSON response template for List tokens operation in Directory API.

JSON template for User object in Directory API.

JSON template for About (notes) of a user in Directory API.

JSON template for address.

JSON template for a set of custom properties (i.e. all fields in a particular schema)

JSON template for an email.

JSON template for an externalId entry.

Attributes

• addressMeAs (type: String.t, default: nil) - AddressMeAs. A human-readable string containing the proper way to refer to the profile owner by humans, for example "he/him/his" or "they/them/their".
• customGender (type: String.t, default: nil) - Custom gender.
• type (type: String.t, default: nil) - Gender.

JSON template for instant messenger of an user.

JSON template for a keyword entry.

JSON template for a language entry.

JSON template for a location entry.

JSON request template for setting/revoking admin status of a user in Directory API.

JSON template for name of a user in Directory API.

JSON template for an organization entry.

JSON template for a phone entry.

JSON template for Photo object in Directory API.

JSON template for a POSIX account entry. Description of the field family: go/fbs-posix.

JSON template for a relation entry.

JSON template for a POSIX account entry.

JSON request template to undelete a user in Directory API.

JSON template for a website entry.

JSON response template for List Users operation in Apps Directory API.

JSON template for verification codes in Directory API.

JSON response template for List verification codes operation in Directory API.

API client metadata for GoogleApi.Admin.Reports_v1.

API calls for all endpoints tagged Activities.

API calls for all endpoints tagged Channels.

API calls for all endpoints tagged CustomerUsageReports.

API calls for all endpoints tagged EntityUsageReports.

API calls for all endpoints tagged UserUsageReport.

Handle Tesla connections for GoogleApi.Admin.Reports_v1.

JSON template for a collection of activites.

JSON template for the activity resource.

User doing the action.

Attributes

• name (type: String.t, default: nil) - Name of the event. This is the specific name of the activity reported by the API. And each eventName is related to a specific G Suite service or feature which the API organizes into types of events. For eventName request parameters in general:
  • If no eventName is given, the report returns all possible instances of an eventName.
  • When you request an eventName, the API's response returns all activities which contain that eventName. It is possible that the returned activities will have other eventName properties in addition to the one requested.
    
    For more information about eventName properties, see the list of event names for various applications above in applicationName.
• parameters (type: list(GoogleApi.Admin.Reports_v1.Model.ActivityEventsParameters.t), default: nil) - Parameter value pairs for various applications. For more information about eventName parameters, see the list of event names for various applications above in applicationName.
• type (type: String.t, default: nil) - Type of event. The G Suite service or feature that an administrator changes is identified in the type property which identifies an event using the eventName property. For a full list of the API's type categories, see the list of event names for various applications above in applicationName.

Attributes

• boolValue (type: boolean(), default: nil) - Boolean value of the parameter.
• intValue (type: String.t, default: nil) - Integer value of the parameter.
• messageValue (type: GoogleApi.Admin.Reports_v1.Model.ActivityEventsParametersMessageValue.t, default: nil) - Nested parameter value pairs associated with this parameter. Complex value type for a parameter are returned as a list of parameter values. For example, the address parameter may have a value as [{parameter: [{name: city, value: abc}]}]
• multiIntValue (type: list(String.t), default: nil) - Integer values of the parameter.
• multiMessageValue (type: list(GoogleApi.Admin.Reports_v1.Model.ActivityEventsParametersMultiMessageValue.t), default: nil) - List of messageValue objects.
• multiValue (type: list(String.t), default: nil) - String values of the parameter.
• name (type: String.t, default: nil) - The name of the parameter.
• value (type: String.t, default: nil) - String value of the parameter.

Nested parameter value pairs associated with this parameter. Complex value type for a parameter are returned as a list of parameter values. For example, the address parameter may have a value as [{parameter: [{name: city, value: abc}]}]

Attributes

• parameter (type: list(GoogleApi.Admin.Reports_v1.Model.NestedParameter.t), default: nil) - Parameter values

Unique identifier for each activity record.

An notification channel used to watch for resource changes.

JSON template for a parameter used in various reports.

JSON template for a usage report.

Information about the type of the item.

Attributes

• boolValue (type: boolean(), default: nil) - Boolean value of the parameter.
• datetimeValue (type: DateTime.t, default: nil) - The RFC 3339 formatted value of the parameter, for example 2010-10-28T10:26:35.000Z.
• intValue (type: String.t, default: nil) - Integer value of the parameter.
• msgValue (type: list(map()), default: nil) - Nested message value of the parameter.
• name (type: String.t, default: nil) -
• stringValue (type: String.t, default: nil) - String value of the parameter.

Attributes

• etag (type: String.t, default: nil) - ETag of the resource.
• kind (type: String.t, default: admin#reports#usageReports) - The type of API resource. For a usage report, the value is admin#reports#usageReports.
• nextPageToken (type: String.t, default: nil) - Token to specify next page. A report with multiple pages has a nextPageToken property in the response. For your follow-on requests getting all of the report's pages, enter the nextPageToken value in the pageToken query string.
• usageReports (type: list(GoogleApi.Admin.Reports_v1.Model.UsageReport.t), default: nil) - Various application parameter records.
• warnings (type: list(GoogleApi.Admin.Reports_v1.Model.UsageReportsWarnings.t), default: nil) - Warnings, if any.

Attributes

• code (type: String.t, default: nil) - Machine readable code or warning type. The warning code value is 200.
• data (type: list(GoogleApi.Admin.Reports_v1.Model.UsageReportsWarningsData.t), default: nil) - Key-value pairs to give detailed information on the warning.
• message (type: String.t, default: nil) - The human readable messages for a warning are:
  • Data is not available warning - Sorry, data for date yyyy-mm-dd for application "application name" is not available.
  • Partial data is available warning - Data for date yyyy-mm-dd for application "application name" is not available right now, please try again after a few hours.

Attributes

• key (type: String.t, default: nil) - Key associated with a key-value pair to give detailed information on the warning.
• value (type: String.t, default: nil) - Value associated with a key-value pair to give detailed information on the warning.