get method
Gets the client state for the device user
Request parameters:
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}
.
Value must have pattern
^devices/\[^/\]+/deviceUsers/\[^/\]+/clientStates/\[^/\]+$
.
customer
- Optional.
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}
, where customer is the customer
to whom the device belongs.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a GoogleAppsCloudidentityDevicesV1ClientState.
Completes with a commons.ApiRequestError if the API endpoint returned an error.
If the used http.Client
completes with an error when making a REST call,
this method will complete with the same error.
Implementation
async.Future<GoogleAppsCloudidentityDevicesV1ClientState> get(
core.String name, {
core.String? customer,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (customer != null) 'customer': [customer],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return GoogleAppsCloudidentityDevicesV1ClientState.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}