Documentation

Google_Service_CloudIdentity_Resource_DevicesDeviceUsers extends Google_Service_Resource
in package

The "deviceUsers" collection of methods.

Typical usage is: $cloudidentityService = new Google_Service_CloudIdentity(...); $deviceUsers = $cloudidentityService->deviceUsers;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
approve()  : Google_Service_CloudIdentity_Operation
Approves device to access user data. (deviceUsers.approve)
block()  : Google_Service_CloudIdentity_Operation
Blocks device from accessing user data (deviceUsers.block)
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
cancelWipe()  : Google_Service_CloudIdentity_Operation
Cancels an unfinished user account wipe. This operation can be used to cancel device wipe in the gap between the wipe operation returning success and the device being wiped. (deviceUsers.cancelWipe)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_CloudIdentity_Operation
Deletes the specified DeviceUser. This also revokes the user's access to device data. (deviceUsers.delete)
get()  : Google_Service_CloudIdentity_GoogleAppsCloudidentityDevicesV1DeviceUser
Retrieves the specified DeviceUser (deviceUsers.get)
listDevicesDeviceUsers()  : Google_Service_CloudIdentity_GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse
Lists/Searches DeviceUsers. (deviceUsers.listDevicesDeviceUsers)
lookup()  : Google_Service_CloudIdentity_GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse
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.
wipe()  : Google_Service_CloudIdentity_Operation
Wipes the user's account on a device. Other data on the device that is not associated with the user's work account is not affected. For example, if a Gmail app is installed on a device that is used for personal and work purposes, and the user is logged in to the Gmail app with their personal account as well as their work account, wiping the "deviceUser" by their work administrator will not affect their personal account within Gmail or other apps such as Photos. (deviceUsers.wipe)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

approve()

Approves device to access user data. (deviceUsers.approve)

public approve(string $name, Google_Service_CloudIdentity_GoogleAppsCloudidentityDevicesV1ApproveDeviceUserRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudIdentity_Operation
Parameters
$name : string

Required. Resource name of the Device in format: devices/{device_id}/deviceUsers/{device_user_id}, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.

$postBody : Google_Service_CloudIdentity_GoogleAppsCloudidentityDevicesV1ApproveDeviceUserRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudIdentity_Operation —

block()

Blocks device from accessing user data (deviceUsers.block)

public block(string $name, Google_Service_CloudIdentity_GoogleAppsCloudidentityDevicesV1BlockDeviceUserRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudIdentity_Operation
Parameters
$name : string

Required. Resource name of the Device in format: devices/{device_id}/deviceUsers/{device_user_id}, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.

$postBody : Google_Service_CloudIdentity_GoogleAppsCloudidentityDevicesV1BlockDeviceUserRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudIdentity_Operation —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

cancelWipe()

Cancels an unfinished user account wipe. This operation can be used to cancel device wipe in the gap between the wipe operation returning success and the device being wiped. (deviceUsers.cancelWipe)

public cancelWipe(string $name, Google_Service_CloudIdentity_GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudIdentity_Operation
Parameters
$name : string

Required. Resource name of the Device in format: devices/{device_id}/deviceUsers/{device_user_id}, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.

$postBody : Google_Service_CloudIdentity_GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudIdentity_Operation —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

delete()

Deletes the specified DeviceUser. This also revokes the user's access to device data. (deviceUsers.delete)

public delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudIdentity_Operation
Parameters
$name : string

Required. Resource name of the Device in format: devices/{device_id}/deviceUsers/{device_user_id}, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string customer Required. Resource name of the customer. 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.

Return values
Google_Service_CloudIdentity_Operation —

get()

Retrieves the specified DeviceUser (deviceUsers.get)

public get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudIdentity_GoogleAppsCloudidentityDevicesV1DeviceUser
Parameters
$name : string

Required. Resource name of the Device in format: devices/{device_id}/deviceUsers/{device_user_id}, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string customer Required. Resource name of the customer. 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.

Return values
Google_Service_CloudIdentity_GoogleAppsCloudidentityDevicesV1DeviceUser —

listDevicesDeviceUsers()

Lists/Searches DeviceUsers. (deviceUsers.listDevicesDeviceUsers)

public listDevicesDeviceUsers(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudIdentity_GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse
Parameters
$parent : string

Required. To list all DeviceUsers, set this to "devices/-". To list all DeviceUsers owned by a device, set this to the resource name of the device. Format: devices/{device}

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string orderBy Optional. Order specification for devices in the response.

opt_param

string filter Optional. Additional restrictions when fetching list of devices. HC article

opt_param

string pageToken Optional. A page token, received from a previous ListDeviceUsers call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListBooks must match the call that provided the page token.

opt_param

string customer Required. Resource name of the customer. 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.

opt_param

int pageSize Optional. The maximum number of DeviceUsers to return. If unspecified, at most 5 DeviceUsers will be returned. The maximum value is 20; values above 20 will be coerced to 20.

Return values
Google_Service_CloudIdentity_GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse —

lookup()

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.

public lookup(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudIdentity_GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse

(deviceUsers.lookup)

Parameters
$parent : string

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

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

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

opt_param

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

opt_param

string androidId Android Id returned by [Settings.Secure#ANDROID_I D](https://developer.android.com/reference/android/provider/Settings.Secure.h tml#ANDROID_ID).

opt_param

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

opt_param

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

Return values
Google_Service_CloudIdentity_GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse —

wipe()

Wipes the user's account on a device. Other data on the device that is not associated with the user's work account is not affected. For example, if a Gmail app is installed on a device that is used for personal and work purposes, and the user is logged in to the Gmail app with their personal account as well as their work account, wiping the "deviceUser" by their work administrator will not affect their personal account within Gmail or other apps such as Photos. (deviceUsers.wipe)

public wipe(string $name, Google_Service_CloudIdentity_GoogleAppsCloudidentityDevicesV1WipeDeviceUserRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudIdentity_Operation
Parameters
$name : string

Required. Resource name of the Device in format: devices/{device_id}/deviceUsers/{device_user_id}, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.

$postBody : Google_Service_CloudIdentity_GoogleAppsCloudidentityDevicesV1WipeDeviceUserRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudIdentity_Operation —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results