GoogleApi.CloudIdentity.V1.Api.Devices.cloudidentity_devices_device_users_lookup

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

cloudidentity_devices_device_users_lookup(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

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

Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: No properties need to be passed, the caller's credentials are sufficient to identify the corresponding DeviceUser. - Android: Specifying the 'android_id' field is required. - Desktop: Specifying the 'raw_resource_id' field is required.

Parameters

  • connection (type: GoogleApi.CloudIdentity.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Must be set to "devices/-/deviceUsers" to search across all DeviceUser belonging to the user.
  • 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").
    • :androidId (type: String.t) - Android Id returned by Settings.Secure#ANDROID_ID.
    • :pageSize (type: integer()) - The maximum number of DeviceUsers to return. If unspecified, at most 20 DeviceUsers will be returned. The maximum value is 20; values above 20 will be coerced to 20.
    • :pageToken (type: String.t) - A page token, received from a previous LookupDeviceUsers call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to LookupDeviceUsers must match the call that provided the page token.
    • :rawResourceId (type: String.t) - Raw Resource Id used by Google Endpoint Verification. If the user is enrolled into Google Endpoint Verification, this id will be saved as the 'device_resource_id' field in the following platform dependent files. Mac: ~/.secureConnect/context_aware_config.json Windows: C:\Users\%USERPROFILE%.secureConnect\context_aware_config.json Linux: ~/.secureConnect/context_aware_config.json
    • :userId (type: String.t) - The user whose DeviceUser's resource name will be fetched. Must be set to 'me' to fetch the DeviceUser's resource name for the calling user.
  • opts (type: keyword()) - Call options

Returns

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