GoogleApi.CloudIdentity.V1.Api.Devices.cloudidentity_devices_device_users_client_states_patch

You're seeing just the function cloudidentity_devices_device_users_client_states_patch, go back to GoogleApi.CloudIdentity.V1.Api.Devices module for more information.
Link to this function

cloudidentity_devices_device_users_client_states_patch(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

cloudidentity_devices_device_users_client_states_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudIdentity.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.CloudIdentity.V1.Connection.t) - Connection to server
  • name (type: String.t) - Output only. Resource name of the ClientState in format: devices/{device_id}/deviceUsers/{device_user_id}/clientState/{partner_id}, where partner_id 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_id}-suffix, where customer_id 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')
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :customer (type: String.t) - 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_id}, where customer_id is the customer to whom the device belongs.
    • :updateMask (type: String.t) - Optional. Comma-separated list of fully qualified names of fields to be updated. If not specified, all updatable fields in ClientState are updated.
    • :body (type: GoogleApi.CloudIdentity.V1.Model.GoogleAppsCloudidentityDevicesV1ClientState.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudIdentity.V1.Model.Operation{}} on success
  • {:error, info} on failure