google_api_admin v0.37.0

GoogleApi.Admin.Directory_v1.Api.Mobiledevices (google_api_admin v0.37.0) View Source

API calls for all endpoints tagged Mobiledevices.

Link to this section Summary

Functions

directory_mobiledevices_action(connection, customer_id, resource_id, optional_params \\ [], opts \\ [])

Takes an action that affects a mobile device. For example, remotely wiping a device.

directory_mobiledevices_delete(connection, customer_id, resource_id, optional_params \\ [], opts \\ [])

Removes a mobile device.

directory_mobiledevices_get(connection, customer_id, resource_id, optional_params \\ [], opts \\ [])

Retrieves a mobile device's properties.

directory_mobiledevices_list(connection, customer_id, optional_params \\ [], opts \\ [])

Retrieves a paginated list of all mobile devices for an account.

Link to this section Functions

Link to this function

directory_mobiledevices_action(connection, customer_id, resource_id, optional_params \\ [], opts \\ [])

View Source

Specs

directory_mobiledevices_action(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Takes an action that affects a mobile device. For example, remotely wiping a device.

Parameters

  • connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
  • customer_id (type: String.t) - The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the my_customer alias to represent your account's customerId. The customerId is also returned as part of the Users resource.
  • resource_id (type: String.t) - The unique ID the API service uses to identify the mobile device.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Admin.Directory_v1.Model.MobileDeviceAction.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %{}} on success
  • {:error, info} on failure
Link to this function

directory_mobiledevices_delete(connection, customer_id, resource_id, optional_params \\ [], opts \\ [])

View Source

Specs

directory_mobiledevices_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Removes a mobile device.

Parameters

  • connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
  • customer_id (type: String.t) - The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the my_customer alias to represent your account's customerId. The customerId is also returned as part of the Users resource.
  • resource_id (type: String.t) - The unique ID the API service uses to identify the mobile device.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %{}} on success
  • {:error, info} on failure
Link to this function

directory_mobiledevices_get(connection, customer_id, resource_id, optional_params \\ [], opts \\ [])

View Source

Specs

directory_mobiledevices_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Admin.Directory_v1.Model.MobileDevice.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves a mobile device's properties.

Parameters

  • connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
  • customer_id (type: String.t) - The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the my_customer alias to represent your account's customerId. The customerId is also returned as part of the Users resource.
  • resource_id (type: String.t) - The unique ID the API service uses to identify the mobile device.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :projection (type: String.t) - Restrict information returned to a set of selected fields.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Admin.Directory_v1.Model.MobileDevice{}} on success
  • {:error, info} on failure
Link to this function

directory_mobiledevices_list(connection, customer_id, optional_params \\ [], opts \\ [])

View Source

Specs

directory_mobiledevices_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Admin.Directory_v1.Model.MobileDevices.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves a paginated list of all mobile devices for an account.

Parameters

  • connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
  • customer_id (type: String.t) - The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the my_customer alias to represent your account's customerId. The customerId is also returned as part of the Users resource.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :maxResults (type: integer()) - Maximum number of results to return. Max allowed value is 100.
    • :orderBy (type: String.t) - Device property to use for sorting results.
    • :pageToken (type: String.t) - Token to specify next page in the list
    • :projection (type: String.t) - Restrict information returned to a set of selected fields.
    • :query (type: String.t) - Search string in the format given at https://developers.google.com/admin-sdk/directory/v1/search-operators
    • :sortOrder (type: String.t) - Whether to return results in ascending or descending order. Must be used with the orderBy parameter.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Admin.Directory_v1.Model.MobileDevices{}} on success
  • {:error, info} on failure