1. class
  2. Google
  3. \
  4. Service
  5. \
  6. CloudIdentity
  7. \
  8. Resource
  9. \
  10. DevicesDeviceUsersClientStates

DevicesDeviceUsersClientStates

class DevicesDeviceUsersClientStates extends Resource (View source)

The "clientStates" collection of methods.

Typical usage is:

 $cloudidentityService = new Google\Service\CloudIdentity(...);
 $clientStates = $cloudidentityService->devices_deviceUsers_clientStates;

Methods

GoogleAppsCloudidentityDevicesV1ClientState
get(string $name, array $optParams = [])

Gets the client state for the device user (clientStates.get)

GoogleAppsCloudidentityDevicesV1ListClientStatesResponse
listDevicesDeviceUsersClientStates(string $parent, array $optParams = [])

Lists the client states for the given search query.

Operation
patch(string $name, GoogleAppsCloudidentityDevicesV1ClientState $postBody, array $optParams = [])

Updates the client state for the device user Note: This method is available only to customers who have one of the following SKUs: Enterprise Standard, Enterprise Plus, Enterprise for Education, and Cloud Identity Premium (clientStates.patch)

Details

at line 62
GoogleAppsCloudidentityDevicesV1ClientState get(string $name, array $optParams = [])

Gets the client state for the device user (clientStates.get)

Parameters

string $name

Required. Resource name of the ClientState in format: devices/{device}/deviceUsers/{device_user}/clientStates/{partner}, where device is the unique ID assigned to the Device, device_user is the unique ID assigned to the User and partner identifies the partner storing the data. To get the client state for devices belonging to your own organization, the partnerId is in the format: customerId-*anystring*. Where the customerId is your organization's customer ID and anystring is any suffix. This suffix is used in setting up Custom Access Levels in Context- Aware Access. You may use my_customer instead of the customer ID for devices managed by your own organization. You may specify - in place of the {device}, so the ClientState resource name can be: devices/-/deviceUsers/{device_user_resource}/clientStates/{partner}.
array $optParams

Optional parameters.

Return Value

GoogleAppsCloudidentityDevicesV1ClientState

Exceptions

Exception

at line 95
GoogleAppsCloudidentityDevicesV1ListClientStatesResponse listDevicesDeviceUsersClientStates(string $parent, array $optParams = [])

Lists the client states for the given search query.

(clientStates.listDevicesDeviceUsersClientStates)

Parameters

string $parent

Required. To list all ClientStates, set this to "devices/-/deviceUsers/-". To list all ClientStates owned by a DeviceUser, set this to the resource name of the DeviceUser. Format: devices/{device}/deviceUsers/{deviceUser}
array $optParams

Optional parameters.

Return Value

GoogleAppsCloudidentityDevicesV1ListClientStatesResponse

Exceptions

Exception

at line 138
Operation patch(string $name, GoogleAppsCloudidentityDevicesV1ClientState $postBody, array $optParams = [])

Updates the client state for the device user Note: This method is available only to customers who have one of the following SKUs: Enterprise Standard, Enterprise Plus, Enterprise for Education, and Cloud Identity Premium (clientStates.patch)

Parameters

string $name

Output only. Resource name of the ClientState in format: devices/{device}/deviceUsers/{device_user}/clientState/{partner}, where partner corresponds to the partner storing the data. For partners belonging to the "BeyondCorp Alliance", this is the partner ID specified to you by Google. For all other callers, this is a string of the form: {customer}-suffix, where customer is your customer ID. The suffix is any string the caller specifies. This string will be displayed verbatim in the administration console. This suffix is used in setting up Custom Access Levels in Context-Aware Access. Your organization's customer ID can be obtained from the URL: GET https://www.googleapis.com/admin/directory/v1/customers/my_customer The id field in the response contains the customer ID starting with the letter 'C'. The customer ID to be used in this API is the string after the letter 'C' (not including 'C')
GoogleAppsCloudidentityDevicesV1ClientState $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception