Cloud Identity API . devices . deviceUsers . clientStates

close()

Close httplib2 connections.

get(name, customer=None, x__xgafv=None)

Gets the client state for the device user

Args:
  name: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) 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}`. (required)
  customer: string, Optional. [Resource name](https://cloud.google.com/apis/design/resource_names) 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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents the state associated with an API client calling the Devices API. Resource representing ClientState and supports updates from API users
  "assetTags": [ # The caller can specify asset tags for this resource
    "A String",
  ],
  "complianceState": "A String", # The compliance state of the resource as specified by the API client.
  "createTime": "A String", # Output only. The time the client state data was created.
  "customId": "A String", # This field may be used to store a unique identifier for the API resource within which these CustomAttributes are a field.
  "etag": "A String", # The token that needs to be passed back for concurrency control in updates. Token needs to be passed back in UpdateRequest
  "healthScore": "A String", # The Health score of the resource
  "keyValuePairs": { # 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.
    "a_key": { # Additional custom attribute values may be one of these types
      "boolValue": True or False, # Represents a boolean value.
      "numberValue": 3.14, # Represents a double value.
      "stringValue": "A String", # Represents a string value.
    },
  },
  "lastUpdateTime": "A String", # Output only. The time the client state data was last updated.
  "managed": "A String", # The management state of the resource as specified by the API client.
  "name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) 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.
  "ownerType": "A String", # Output only. The owner of the ClientState
  "scoreReason": "A String", # A descriptive cause of the health score.
}

patch(name, body=None, customer=None, updateMask=None, x__xgafv=None)

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

Args:
  name: string, Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) 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. (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents the state associated with an API client calling the Devices API. Resource representing ClientState and supports updates from API users
  "assetTags": [ # The caller can specify asset tags for this resource
    "A String",
  ],
  "complianceState": "A String", # The compliance state of the resource as specified by the API client.
  "createTime": "A String", # Output only. The time the client state data was created.
  "customId": "A String", # This field may be used to store a unique identifier for the API resource within which these CustomAttributes are a field.
  "etag": "A String", # The token that needs to be passed back for concurrency control in updates. Token needs to be passed back in UpdateRequest
  "healthScore": "A String", # The Health score of the resource
  "keyValuePairs": { # 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.
    "a_key": { # Additional custom attribute values may be one of these types
      "boolValue": True or False, # Represents a boolean value.
      "numberValue": 3.14, # Represents a double value.
      "stringValue": "A String", # Represents a string value.
    },
  },
  "lastUpdateTime": "A String", # Output only. The time the client state data was last updated.
  "managed": "A String", # The management state of the resource as specified by the API client.
  "name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) 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.
  "ownerType": "A String", # Output only. The owner of the ClientState
  "scoreReason": "A String", # A descriptive cause of the health score.
}

  customer: string, Optional. [Resource name](https://cloud.google.com/apis/design/resource_names) 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: string, Optional. Comma-separated list of fully qualified names of fields to be updated. If not specified, all updatable fields in ClientState are updated.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}