API Reference google_api_admin v0.26.0

Modules

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.

Applications resources represent applications installed on the domain that support transferring ownership of user data.

Template to map fields of ApplicationDataTransfer resource.

Template for application transfer parameters.

Template for a collection of Applications.

A Transfer resource represents the transfer of the ownership of user data between users.

Template for a collection of DataTransfer resources.

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 Customer.

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 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 TwoStepVerification.

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.

An application-specific password (ASP) is used with applications that do not accept a verification code when logging into the application on certain devices. The ASP access code is used instead of the login and password you commonly use when accessing an application through a browser. For more information about ASPs and how to create one, see the help center.

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.

Public API: Resources.buildings

Public API: Resources.buildings

Public API: Resources.buildings

Public API: Resources.calendars

An notification channel used to watch for resource changes.

Google Chrome devices run on the Chrome OS. For more information about common API tasks, see the Developer's Guide.

Attributes

  • action (type: String.t, default: nil) - Action to be taken on the Chrome OS device.
  • deprovisionReason (type: String.t, default: nil) - Only used when the action is deprovision. With the deprovision action, this field is required. Note: The deprovision reason is audited because it might have implications on licenses for perpetual subscription customers.

Attributes

  • activeTime (type: integer(), default: nil) - Duration of usage 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

  • 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)

Attributes

  • chromeosdevices (type: list(GoogleApi.Admin.Directory_v1.Model.ChromeOsDevice.t), default: nil) - List of Chrome OS Device objects.
  • etag (type: String.t, default: nil) - ETag of the resource.
  • kind (type: String.t, default: admin#directory#chromeosdevices) - Kind of resource this is.
  • nextPageToken (type: String.t, default: nil) - Token used to access the next page of this result. To access the next page, use this token's value in the pageToken query string of this request.

Attributes

  • deviceIds (type: list(String.t), default: nil) - Chrome OS devices to be moved to OU

Attributes

  • alternateEmail (type: String.t, default: nil) - The customer's secondary contact email address. This email address cannot be on the same domain as the customerDomain
  • customerCreationTime (type: DateTime.t, default: nil) - The customer's creation time (Readonly)
  • customerDomain (type: String.t, default: nil) - The customer's primary domain name string. Do not include the www prefix when creating a new customer.
  • etag (type: String.t, default: nil) - ETag of the resource.
  • id (type: String.t, default: nil) - The unique ID for the customer's G Suite account. (Readonly)
  • kind (type: String.t, default: admin#directory#customer) - Identifies the resource as a customer. Value: admin#directory#customer
  • language (type: String.t, default: nil) - The customer's ISO 639-2 language code. See the Language Codes page for the list of supported codes. Valid language codes outside the supported set will be accepted by the API but may lead to unexpected behavior. The default value is en.
  • phoneNumber (type: String.t, default: nil) - The customer's contact phone number in E.164 format.
  • postalAddress (type: GoogleApi.Admin.Directory_v1.Model.CustomerPostalAddress.t, default: nil) - The customer's postal address information.

Attributes

  • addressLine1 (type: String.t, default: nil) - A customer's physical address. The address can be composed of one to three lines.
  • addressLine2 (type: String.t, default: nil) - Address line 2 of the address.
  • addressLine3 (type: String.t, default: nil) - Address line 3 of the address.
  • contactName (type: String.t, default: nil) - The customer contact's name.
  • countryCode (type: String.t, default: nil) - This is a required property. For countryCode information see the ISO 3166 country code elements.
  • locality (type: String.t, default: nil) - Name of the locality. An example of a locality value is the city of San Francisco.
  • organizationName (type: String.t, default: nil) - The company or company division name.
  • postalCode (type: String.t, default: nil) - The postal code. A postalCode example is a postal zip code such as 10009. This is in accordance with - http: //portablecontacts.net/draft-spec.html#address_element.
  • region (type: String.t, default: nil) - Name of the region. An example of a region value is NY for the state of New York.

Information regarding a command that was issued to a device.

Attributes

  • creationTime (type: String.t, default: nil) - The creation time of the domain alias. (Read-only).
  • domainAliasName (type: String.t, default: nil) - The domain alias name.
  • etag (type: String.t, default: nil) - ETag of the resource.
  • kind (type: String.t, default: admin#directory#domainAlias) - Kind of resource this is.
  • parentDomainName (type: String.t, default: nil) - The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer.
  • verified (type: boolean(), default: nil) - Indicates the verification state of a domain alias. (Read-only)

Attributes

  • domainAliases (type: list(GoogleApi.Admin.Directory_v1.Model.DomainAlias.t), default: nil) - List of domain alias objects.
  • etag (type: String.t, default: nil) - ETag of the resource.
  • kind (type: String.t, default: admin#directory#domainAliases) - Kind of resource this is.

Attributes

  • creationTime (type: String.t, default: nil) - Creation time of the domain. Expressed in Unix time format. (Read-only).
  • domainAliases (type: list(GoogleApi.Admin.Directory_v1.Model.DomainAlias.t), default: nil) - List of domain alias objects. (Read-only)
  • domainName (type: String.t, default: nil) - The domain name of the customer.
  • etag (type: String.t, default: nil) - ETag of the resource.
  • isPrimary (type: boolean(), default: nil) - Indicates if the domain is a primary domain (Read-only).
  • kind (type: String.t, default: admin#directory#domain) - Kind of resource this is.
  • verified (type: boolean(), default: nil) - Indicates the verification state of a domain. (Read-only).

Attributes

  • domains (type: list(GoogleApi.Admin.Directory_v1.Model.Domains.t), default: nil) - List of domain objects.
  • etag (type: String.t, default: nil) - ETag of the resource.
  • kind (type: String.t, default: admin#directory#domains) - Kind of resource this is.

JSON template for Feature object in Directory API.

JSON template for a feature instance.

Attributes

  • newName (type: String.t, default: nil) - New name of the feature.

Public API: Resources.features

Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the Developer's Guide.

Attributes

  • etag (type: String.t, default: nil) - ETag of the resource.
  • groups (type: list(GoogleApi.Admin.Directory_v1.Model.Group.t), default: nil) - List of group objects.
  • kind (type: String.t, default: admin#directory#groups) - Kind of resource this is.
  • nextPageToken (type: String.t, default: nil) - Token used to access next page of this result.

A Google Groups member can be a user or another group. This member can be inside or outside of your account's domains. For more information about common group member tasks, see the Developer's Guide.

Attributes

  • etag (type: String.t, default: nil) - ETag of the resource.
  • kind (type: String.t, default: admin#directory#members) - Kind of resource this is.
  • members (type: list(GoogleApi.Admin.Directory_v1.Model.Member.t), default: nil) - List of member objects.
  • nextPageToken (type: String.t, default: nil) - Token used to access next page of this result.

JSON template for Has Member response in Directory API.

G Suite Mobile Management includes Android, Google Sync, and iOS devices. For more information about common group mobile device API tasks, see the Developer's Guide.

Attributes

  • action (type: String.t, default: nil) - The action to be performed on the device.

Attributes

  • displayName (type: String.t, default: nil) - The application's display name. An example is Browser.
  • packageName (type: String.t, default: nil) - The application's package name. An example is com.android.browser.
  • permission (type: list(String.t), default: nil) - The list of permissions of this application. These can be either a standard Android permission or one defined by the application, and are found in an application's Android manifest. Examples of a Calendar application's permissions are READ_CALENDAR, or MANAGE_ACCOUNTS.
  • versionCode (type: integer(), default: nil) - The application's version code. An example is 13.
  • versionName (type: String.t, default: nil) - The application's version name. An example is 3.2-140714.

Attributes

  • etag (type: String.t, default: nil) - ETag of the resource.
  • kind (type: String.t, default: admin#directory#mobiledevices) - Kind of resource this is.
  • mobiledevices (type: list(GoogleApi.Admin.Directory_v1.Model.MobileDevice.t), default: nil) - List of Mobile Device objects.
  • nextPageToken (type: String.t, default: nil) - Token used to access next page of this result.

Managing your account's organizational units allows you to configure your users' access to services and custom settings. For more information about common organizational unit tasks, see the Developer's Guide.

Attributes

  • etag (type: String.t, default: nil) - ETag of the resource.
  • kind (type: String.t, default: admin#directory#orgUnits) - The type of the API resource. For Org Unit resources, the type is admin#directory#orgUnits.
  • organizationUnits (type: list(GoogleApi.Admin.Directory_v1.Model.OrgUnit.t), default: nil) - List of organizational unit objects.

Attributes

  • childPrivileges (type: list(GoogleApi.Admin.Directory_v1.Model.Privilege.t), default: nil) - A list of child privileges. Privileges for a service form a tree. Each privilege can have a list of child privileges; this list is empty for a leaf privilege.
  • etag (type: String.t, default: nil) - ETag of the resource.
  • isOuScopable (type: boolean(), default: nil) - If the privilege can be restricted to an organization unit.
  • kind (type: String.t, default: admin#directory#privilege) - The type of the API resource. This is always admin#directory#privilege.
  • 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().
  • serviceName (type: String.t, default: nil) - The name of the service this privilege is for.

Attributes

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

List of recent device users, in descending order, by last login time.

Attributes

  • etag (type: String.t, default: nil) - ETag of the resource.
  • isSuperAdminRole (type: boolean(), default: nil) - Returns true if the role is a super admin role.
  • isSystemRole (type: boolean(), default: nil) - Returns true if this is a pre-defined system role.
  • kind (type: String.t, default: admin#directory#role) - The type of the API resource. This is always admin#directory#role.
  • roleDescription (type: String.t, default: nil) - A short description of the role.
  • roleId (type: String.t, default: nil) - ID of the role.
  • roleName (type: String.t, default: nil) - Name of the role.
  • rolePrivileges (type: list(GoogleApi.Admin.Directory_v1.Model.RoleRolePrivileges.t), default: nil) - The set of privileges that are granted to this role.

Attributes

  • assignedTo (type: String.t, default: nil) - The unique ID of the user this role is assigned to.
  • etag (type: String.t, default: nil) - ETag of the resource.
  • kind (type: String.t, default: admin#directory#roleAssignment) - The type of the API resource. This is always admin#directory#roleAssignment.
  • orgUnitId (type: String.t, default: nil) - If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to.
  • roleAssignmentId (type: String.t, default: nil) - ID of this roleAssignment.
  • roleId (type: String.t, default: nil) - The ID of the role that is assigned.
  • scopeType (type: String.t, default: nil) - The scope in which this role is assigned.

Attributes

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

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().

Attributes

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

The type of API resource. For Schema resources, this is always admin#directory#schema.

You can use schemas to add custom fields to user profiles. You can use these fields to store information such as the projects your users work on, their physical locations, their hire dates, or whatever else fits your business needs. For more information, see Custom User Fields.

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.

The Directory API allows you to create and manage your account's users, user aliases, and user Gmail chat profile photos. For more information about common tasks, see the User Accounts Developer's Guide and the User Aliases Developer's Guide.

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

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.

Attributes

  • status (type: boolean(), default: nil) - Indicates the administrator status of the user.

Attributes

  • familyName (type: String.t, default: nil) - The user's last name. Required when creating a user account.
  • fullName (type: String.t, default: nil) - The user's full name formed by concatenating the first and last name values.
  • givenName (type: String.t, default: nil) - The user's first name. Required when creating a user account.

JSON template for an organization entry.

JSON template for a phone entry.

Attributes

  • etag (type: String.t, default: nil) - ETag of the resource.
  • height (type: integer(), default: nil) - Height of the photo in pixels.
  • id (type: String.t, default: nil) - The ID the API uses to uniquely identify the user.
  • kind (type: String.t, default: admin#directory#user#photo) - The type of the API resource. For Photo resources, this is admin#directory#user#photo.
  • mimeType (type: String.t, default: nil) - The MIME type of the photo. Allowed values are JPEG, PNG, GIF, BMP, TIFF, and web-safe base64 encoding.
  • photoData (type: String.t, default: nil) - The user photo's upload data in web-safe Base64 format in bytes. This means: The slash (/) character is replaced with the underscore (_) character. The plus sign (+) character is replaced with the hyphen (-) character. The equals sign (=) character is replaced with the asterisk (). For padding, the period (.) character is used instead of the RFC-4648 baseURL definition which uses the equals sign (=) for padding. This is done to simplify URL-parsing. Whatever the size of the photo being uploaded, the API downsizes it to 96x96 pixels.
  • primaryEmail (type: String.t, default: nil) - The user's primary email address.
  • width (type: integer(), default: nil) - Width of the photo in pixels.

JSON template for a POSIX account entry.

JSON template for a relation entry.

JSON template for a POSIX account entry.

Attributes

  • orgUnitPath (type: String.t, default: nil) - OrgUnit of User

JSON template for a website entry.

Attributes

  • etag (type: String.t, default: nil) - ETag of the resource.
  • kind (type: String.t, default: admin#directory#users) - Kind of resource this is.
  • nextPageToken (type: String.t, default: nil) - Token used to access next page of this result.
  • trigger_event (type: String.t, default: nil) - Event that triggered this response (only used in case of Push Response)
  • users (type: list(GoogleApi.Admin.Directory_v1.Model.User.t), default: nil) - List of user objects.

The Directory API allows you to view, generate, and invalidate backup verification codes for a user.

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 activities.

JSON template for the activity resource.

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.

A notification channel used to watch for resource changes.

JSON template for a parameter used in various reports.

JSON template for a usage report.

Output only. Information about the type of the item.

Attributes

  • boolValue (type: boolean(), default: nil) - Output only. 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) - Output only. Integer value of the parameter.
  • msgValue (type: list(map()), default: nil) - Output only. Nested message value of the parameter.
  • name (type: String.t, default: nil) - The name of the parameter. For the User Usage Report parameter names, see the User Usage parameters reference.
  • stringValue (type: String.t, default: nil) - Output only. 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.