Class DevicesResource.DeviceUsersResource.LookupRequest

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: Specifying the 'partner' and 'ios_device_id' fields is required. - Android: Specifying the 'android_id' field is required. - Desktop: Specifying the 'raw_resource_id' field is required.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse>
CloudIdentityBaseServiceRequest<GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse>
DevicesResource.DeviceUsersResource.LookupRequest
Implements
Inherited Members
Namespace: Google.Apis.CloudIdentity.v1
Assembly: Google.Apis.CloudIdentity.v1.dll
Syntax
public class DevicesResource.DeviceUsersResource.LookupRequest : CloudIdentityBaseServiceRequest<GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse>, IClientServiceRequest<GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse>, IClientServiceRequest

Constructors

LookupRequest(IClientService, string)

Constructs a new Lookup request.

Declaration
public LookupRequest(IClientService service, string parent)
Parameters
Type Name Description
IClientService service
string parent

Properties

AndroidId

Android Id returned by Settings.Secure#ANDROID_ID.

Declaration
[RequestParameter("androidId", RequestParameterType.Query)]
public virtual string AndroidId { get; set; }
Property Value
Type Description
string

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

IosDeviceId

Optional. The partner-specified device identifier assigned to the iOS device that initiated the Lookup API call. This string must match the value of the iosDeviceId key in the app config dictionary provided to Google Workspace apps.

Declaration
[RequestParameter("iosDeviceId", RequestParameterType.Query)]
public virtual string IosDeviceId { get; set; }
Property Value
Type Description
string

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

PageSize

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.

Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type Description
int?

PageToken

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.

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

Parent

Must be set to "devices/-/deviceUsers" to search across all DeviceUser belonging to the user.

Declaration
[RequestParameter("parent", RequestParameterType.Path)]
public virtual string Parent { get; }
Property Value
Type Description
string

Partner

Optional. The partner ID of the calling iOS app. This string must match the value of the partner key within the app configuration dictionary provided to Google Workspace apps.

Declaration
[RequestParameter("partner", RequestParameterType.Query)]
public virtual string Partner { get; set; }
Property Value
Type Description
string

RawResourceId

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

Declaration
[RequestParameter("rawResourceId", RequestParameterType.Query)]
public virtual string RawResourceId { get; set; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

UserId

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.

Declaration
[RequestParameter("userId", RequestParameterType.Query)]
public virtual string UserId { get; set; }
Property Value
Type Description
string

Methods

InitParameters()

Initializes Lookup parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements