patch
Updates the client state for the device user
Synopsis
Implements the API documented at https://cloud.google.com/identity/docs/reference/rest/v1/devices.deviceUsers.clientStates/patch
gsm clientStates patch [flags]
Options
--assetTags strings The caller can specify asset tags for this resource
--customId string This field may be used to store a unique identifier for the API resource within which these CustomAttributes are a field.
--customer string 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. (default "customers/my_customer")
--etag string The token that needs to be passed back for concurrency control in updates.
Token needs to be passed back in UpdateRequest
--fields string Fields allows partial responses to be retrieved.
See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
-h, --help help for patch
--keyValuePairs strings The map of key-value attributes stored by callers specific to a device.
The total serialized length of this map may not exceed 10KB.
No limit is placed on the number of attributes in a map.
Can be used multiple times in the format: "key=name;value=wrench;type=string"
where type may be one of the following
string
bool
number
--name string Resource name of the ClientState in format: devices/{device_id}/deviceUsers/{device_user_id}/clientStates/{partner_id},
where device_id is the unique ID assigned to the Device, device_user_id is the unique ID assigned to the User and partner_id 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_id}, so the ClientState resource name can be: devices/-/deviceUsers/{device_user_resource_id}/clientStates/{partner_id}.
Options inherited from parent commands
--compressOutput By default, GSM outputs "pretty" (indented) objects. By setting this flag, GSM's output will be compressed. This may or may not improve performance in scripts.
--config string config file (default is $HOME/.config/gsm/.gsm.yaml)
--delay int This delay (plus a random jitter between 0 and 50) will be applied after every command to avoid reaching quota and rate limits. Set to 0 to disable.
--dwdSubject string Specify a subject used for DWD impersonation (overrides value in config file)
--log string Set the path of the log file. Default is either ~/gsm.log or defined in your config file
--maxElapsedTime int This is the maximum total time that will be spent retrying a request in minutes. (default 15)
--maxRetryInterval int This is the maximum interval that will be used between retry attempts in seconds. (default 320)
--redirectPort int This is the TCP port on which GSM will create web server if you authenticate with a user account for the first time. This is necessary for the OAuth flow. See https://developers.google.com/identity/protocols/oauth2/native-app#redirect-uri_loopback (default 8081)
--retryOn ints Specify the HTTP error code(s) that GSM should retry on. Note that GSM will always retry on HTTP 403 errors that indicate a quota / rate limit error
--streamOutput Setting this flag will cause GSM to output slice values to stdout one by one, instead of one large object
SEE ALSO
- gsm clientStates - Manage client states (Part of Cloud Identity API)
- gsm clientStates patch batch - Batch patches client states using a CSV file as input.