GoogleApi.CloudIdentity.V1.Api.Devices.cloudidentity_devices_list

You're seeing just the function cloudidentity_devices_list, go back to GoogleApi.CloudIdentity.V1.Api.Devices module for more information.
Link to this function

cloudidentity_devices_list(connection, optional_params \\ [], opts \\ [])

View Source

Specs

cloudidentity_devices_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok,
   GoogleApi.CloudIdentity.V1.Model.GoogleAppsCloudidentityDevicesV1ListDevicesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists/Searches devices.

Parameters

  • connection (type: GoogleApi.CloudIdentity.V1.Connection.t) - Connection to server
  • 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").
    • :customer (type: String.t) - Optional. Resource name of the customer in the format: customers/{customer_id}, where customer_id is the customer to whom the device belongs. If you're using this API for your own organization, use customers/my_customer. If you're using this API to manage another organization, use customers/{customer_id}, where customer_id is the customer to whom the device belongs.
    • :filter (type: String.t) - Optional. Additional restrictions when fetching list of devices. For a list of search fields, refer to Mobile device search fields. Multiple search fields are separated by the space character.
    • :orderBy (type: String.t) - Optional. Order specification for devices in the response. Only one of the following field names may be used to specify the order: create_time, last_sync_time, model, os_version, device_type and serial_number. desc may be specified optionally at the end to specify results to be sorted in descending order. Default order is ascending.
    • :pageSize (type: integer()) - Optional. The maximum number of Devices to return. If unspecified, at most 20 Devices will be returned. The maximum value is 100; values above 100 will be coerced to 100.
    • :pageToken (type: String.t) - Optional. A page token, received from a previous ListDevices call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDevices must match the call that provided the page token.
    • :view (type: String.t) - Optional. The view to use for the List request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudIdentity.V1.Model.GoogleAppsCloudidentityDevicesV1ListDevicesResponse{}} on success
  • {:error, info} on failure