| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="cloudidentity_v1beta1.html">Cloud Identity API</a> . <a href="cloudidentity_v1beta1.devices.html">devices</a> . <a href="cloudidentity_v1beta1.devices.deviceUsers.html">deviceUsers</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="cloudidentity_v1beta1.devices.deviceUsers.clientStates.html">clientStates()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the clientStates Resource.</p> |
| 81 | |
| 82 | <p class="toc_element"> |
| 83 | <code><a href="#approve">approve(name, body=None, x__xgafv=None)</a></code></p> |
| 84 | <p class="firstline">Approves device to access user data.</p> |
| 85 | <p class="toc_element"> |
| 86 | <code><a href="#block">block(name, body=None, x__xgafv=None)</a></code></p> |
| 87 | <p class="firstline">Blocks device from accessing user data</p> |
| 88 | <p class="toc_element"> |
| 89 | <code><a href="#cancelWipe">cancelWipe(name, body=None, x__xgafv=None)</a></code></p> |
| 90 | <p class="firstline">Cancels an unfinished user account wipe. This operation can be used to cancel device wipe in the gap between the wipe operation returning success and the device being wiped.</p> |
| 91 | <p class="toc_element"> |
| 92 | <code><a href="#close">close()</a></code></p> |
| 93 | <p class="firstline">Close httplib2 connections.</p> |
| 94 | <p class="toc_element"> |
| 95 | <code><a href="#delete">delete(name, customer=None, x__xgafv=None)</a></code></p> |
| 96 | <p class="firstline">Deletes the specified DeviceUser. This also revokes the user's access to device data.</p> |
| 97 | <p class="toc_element"> |
| 98 | <code><a href="#get">get(name, customer=None, x__xgafv=None)</a></code></p> |
| 99 | <p class="firstline">Retrieves the specified DeviceUser</p> |
| 100 | <p class="toc_element"> |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 101 | <code><a href="#list">list(parent, customer=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 102 | <p class="firstline">Lists/Searches DeviceUsers.</p> |
| 103 | <p class="toc_element"> |
| 104 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 105 | <p class="firstline">Retrieves the next page of results.</p> |
| 106 | <p class="toc_element"> |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 107 | <code><a href="#lookup">lookup(parent, androidId=None, pageSize=None, pageToken=None, rawResourceId=None, userId=None, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 108 | <p class="firstline">Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: No properties need to be passed, the caller's credentials are sufficient to identify the corresponding DeviceUser. - Android: Specifying the 'android_id' field is required. - Desktop: Specifying the 'raw_resource_id' field is required.</p> |
| 109 | <p class="toc_element"> |
| 110 | <code><a href="#lookup_next">lookup_next(previous_request, previous_response)</a></code></p> |
| 111 | <p class="firstline">Retrieves the next page of results.</p> |
| 112 | <p class="toc_element"> |
| 113 | <code><a href="#wipe">wipe(name, body=None, x__xgafv=None)</a></code></p> |
| 114 | <p class="firstline">Wipes the user's account on a device.</p> |
| 115 | <h3>Method Details</h3> |
| 116 | <div class="method"> |
| 117 | <code class="details" id="approve">approve(name, body=None, x__xgafv=None)</code> |
| 118 | <pre>Approves device to access user data. |
| 119 | |
| 120 | Args: |
| 121 | name: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}/deviceUsers/{device_user_id}`, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User. (required) |
| 122 | body: object, The request body. |
| 123 | The object takes the form of: |
| 124 | |
| 125 | { # Request message for approving the device to access user data. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 126 | "customer": "A String", # Required. [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. |
| 127 | } |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 128 | |
| 129 | x__xgafv: string, V1 error format. |
| 130 | Allowed values |
| 131 | 1 - v1 error format |
| 132 | 2 - v2 error format |
| 133 | |
| 134 | Returns: |
| 135 | An object of the form: |
| 136 | |
| 137 | { # This resource represents a long-running operation that is the result of a network API call. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 138 | "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. |
| 139 | "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. |
| 140 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 141 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 142 | { |
| 143 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 144 | }, |
| 145 | ], |
| 146 | "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. |
| 147 | }, |
| 148 | "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. |
| 149 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 150 | }, |
| 151 | "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}`. |
| 152 | "response": { # The normal response of the operation in case of success. 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`. |
| 153 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 154 | }, |
| 155 | }</pre> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 156 | </div> |
| 157 | |
| 158 | <div class="method"> |
| 159 | <code class="details" id="block">block(name, body=None, x__xgafv=None)</code> |
| 160 | <pre>Blocks device from accessing user data |
| 161 | |
| 162 | Args: |
| 163 | name: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}/deviceUsers/{device_user_id}`, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User. (required) |
| 164 | body: object, The request body. |
| 165 | The object takes the form of: |
| 166 | |
| 167 | { # Request message for blocking account on device. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 168 | "customer": "A String", # Required. [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. |
| 169 | } |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 170 | |
| 171 | x__xgafv: string, V1 error format. |
| 172 | Allowed values |
| 173 | 1 - v1 error format |
| 174 | 2 - v2 error format |
| 175 | |
| 176 | Returns: |
| 177 | An object of the form: |
| 178 | |
| 179 | { # This resource represents a long-running operation that is the result of a network API call. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 180 | "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. |
| 181 | "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. |
| 182 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 183 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 184 | { |
| 185 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 186 | }, |
| 187 | ], |
| 188 | "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. |
| 189 | }, |
| 190 | "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. |
| 191 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 192 | }, |
| 193 | "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}`. |
| 194 | "response": { # The normal response of the operation in case of success. 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`. |
| 195 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 196 | }, |
| 197 | }</pre> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 198 | </div> |
| 199 | |
| 200 | <div class="method"> |
| 201 | <code class="details" id="cancelWipe">cancelWipe(name, body=None, x__xgafv=None)</code> |
| 202 | <pre>Cancels an unfinished user account wipe. This operation can be used to cancel device wipe in the gap between the wipe operation returning success and the device being wiped. |
| 203 | |
| 204 | Args: |
| 205 | name: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}/deviceUsers/{device_user_id}`, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User. (required) |
| 206 | body: object, The request body. |
| 207 | The object takes the form of: |
| 208 | |
| 209 | { # Request message for cancelling an unfinished user account wipe. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 210 | "customer": "A String", # Required. [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. |
| 211 | } |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 212 | |
| 213 | x__xgafv: string, V1 error format. |
| 214 | Allowed values |
| 215 | 1 - v1 error format |
| 216 | 2 - v2 error format |
| 217 | |
| 218 | Returns: |
| 219 | An object of the form: |
| 220 | |
| 221 | { # This resource represents a long-running operation that is the result of a network API call. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 222 | "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. |
| 223 | "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. |
| 224 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 225 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 226 | { |
| 227 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 228 | }, |
| 229 | ], |
| 230 | "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. |
| 231 | }, |
| 232 | "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. |
| 233 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 234 | }, |
| 235 | "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}`. |
| 236 | "response": { # The normal response of the operation in case of success. 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`. |
| 237 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 238 | }, |
| 239 | }</pre> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 240 | </div> |
| 241 | |
| 242 | <div class="method"> |
| 243 | <code class="details" id="close">close()</code> |
| 244 | <pre>Close httplib2 connections.</pre> |
| 245 | </div> |
| 246 | |
| 247 | <div class="method"> |
| 248 | <code class="details" id="delete">delete(name, customer=None, x__xgafv=None)</code> |
| 249 | <pre>Deletes the specified DeviceUser. This also revokes the user's access to device data. |
| 250 | |
| 251 | Args: |
| 252 | name: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}/deviceUsers/{device_user_id}`, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User. (required) |
| 253 | customer: string, Required. [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. |
| 254 | x__xgafv: string, V1 error format. |
| 255 | Allowed values |
| 256 | 1 - v1 error format |
| 257 | 2 - v2 error format |
| 258 | |
| 259 | Returns: |
| 260 | An object of the form: |
| 261 | |
| 262 | { # This resource represents a long-running operation that is the result of a network API call. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 263 | "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. |
| 264 | "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. |
| 265 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 266 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 267 | { |
| 268 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 269 | }, |
| 270 | ], |
| 271 | "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. |
| 272 | }, |
| 273 | "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. |
| 274 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 275 | }, |
| 276 | "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}`. |
| 277 | "response": { # The normal response of the operation in case of success. 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`. |
| 278 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 279 | }, |
| 280 | }</pre> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 281 | </div> |
| 282 | |
| 283 | <div class="method"> |
| 284 | <code class="details" id="get">get(name, customer=None, x__xgafv=None)</code> |
| 285 | <pre>Retrieves the specified DeviceUser |
| 286 | |
| 287 | Args: |
| 288 | name: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}/deviceUsers/{device_user_id}`, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User. (required) |
| 289 | customer: string, Required. [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. |
| 290 | x__xgafv: string, V1 error format. |
| 291 | Allowed values |
| 292 | 1 - v1 error format |
| 293 | 2 - v2 error format |
| 294 | |
| 295 | Returns: |
| 296 | An object of the form: |
| 297 | |
| 298 | { # Represents a user's use of a Device in the Cloud Identity Devices API. A DeviceUser is a resource representing a user's use of a Device |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 299 | "compromisedState": "A String", # Compromised State of the DeviceUser object |
| 300 | "createTime": "A String", # When the user first signed in to the device |
| 301 | "firstSyncTime": "A String", # Output only. Most recent time when user registered with this service. |
| 302 | "languageCode": "A String", # Output only. Default locale used on device, in IETF BCP-47 format. |
| 303 | "lastSyncTime": "A String", # Output only. Last time when user synced with policies. |
| 304 | "managementState": "A String", # Output only. Management state of the user on the device. |
| 305 | "name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the DeviceUser in format: `devices/{device_id}/deviceUsers/{user_id}`, where user_id is the ID of the user associated with the user session. |
| 306 | "passwordState": "A String", # Password state of the DeviceUser object |
| 307 | "userAgent": "A String", # Output only. User agent on the device for this specific user |
| 308 | "userEmail": "A String", # Email address of the user registered on the device. |
| 309 | }</pre> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 310 | </div> |
| 311 | |
| 312 | <div class="method"> |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 313 | <code class="details" id="list">list(parent, customer=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 314 | <pre>Lists/Searches DeviceUsers. |
| 315 | |
| 316 | Args: |
| 317 | parent: string, Required. To list all DeviceUsers, set this to "devices/-". To list all DeviceUsers owned by a device, set this to the resource name of the device. Format: devices/{device} (required) |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 318 | customer: string, Required. [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. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 319 | filter: string, Optional. Additional restrictions when fetching list of devices. For a list of search fields, refer to [Mobile device search fields](https://developers.google.com/admin-sdk/directory/v1/search-operators). Multiple search fields are separated by the space character. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 320 | orderBy: string, Optional. Order specification for devices in the response. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 321 | pageSize: integer, Optional. The maximum number of DeviceUsers to return. If unspecified, at most 5 DeviceUsers will be returned. The maximum value is 20; values above 20 will be coerced to 20. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 322 | pageToken: string, Optional. A page token, received from a previous `ListDeviceUsers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBooks` must match the call that provided the page token. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 323 | x__xgafv: string, V1 error format. |
| 324 | Allowed values |
| 325 | 1 - v1 error format |
| 326 | 2 - v2 error format |
| 327 | |
| 328 | Returns: |
| 329 | An object of the form: |
| 330 | |
| 331 | { # Response message that is returned from the ListDeviceUsers method. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 332 | "deviceUsers": [ # Devices meeting the list restrictions. |
| 333 | { # Represents a user's use of a Device in the Cloud Identity Devices API. A DeviceUser is a resource representing a user's use of a Device |
| 334 | "compromisedState": "A String", # Compromised State of the DeviceUser object |
| 335 | "createTime": "A String", # When the user first signed in to the device |
| 336 | "firstSyncTime": "A String", # Output only. Most recent time when user registered with this service. |
| 337 | "languageCode": "A String", # Output only. Default locale used on device, in IETF BCP-47 format. |
| 338 | "lastSyncTime": "A String", # Output only. Last time when user synced with policies. |
| 339 | "managementState": "A String", # Output only. Management state of the user on the device. |
| 340 | "name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the DeviceUser in format: `devices/{device_id}/deviceUsers/{user_id}`, where user_id is the ID of the user associated with the user session. |
| 341 | "passwordState": "A String", # Password state of the DeviceUser object |
| 342 | "userAgent": "A String", # Output only. User agent on the device for this specific user |
| 343 | "userEmail": "A String", # Email address of the user registered on the device. |
| 344 | }, |
| 345 | ], |
| 346 | "nextPageToken": "A String", # Token to retrieve the next page of results. Empty if there are no more results. |
| 347 | }</pre> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 348 | </div> |
| 349 | |
| 350 | <div class="method"> |
| 351 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 352 | <pre>Retrieves the next page of results. |
| 353 | |
| 354 | Args: |
| 355 | previous_request: The request for the previous page. (required) |
| 356 | previous_response: The response from the request for the previous page. (required) |
| 357 | |
| 358 | Returns: |
| 359 | A request object that you can call 'execute()' on to request the next |
| 360 | page. Returns None if there are no more items in the collection. |
| 361 | </pre> |
| 362 | </div> |
| 363 | |
| 364 | <div class="method"> |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 365 | <code class="details" id="lookup">lookup(parent, androidId=None, pageSize=None, pageToken=None, rawResourceId=None, userId=None, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 366 | <pre>Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: No properties need to be passed, the caller's credentials are sufficient to identify the corresponding DeviceUser. - Android: Specifying the 'android_id' field is required. - Desktop: Specifying the 'raw_resource_id' field is required. |
| 367 | |
| 368 | Args: |
| 369 | parent: string, Must be set to "devices/-/deviceUsers" to search across all DeviceUser belonging to the user. (required) |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 370 | androidId: string, Android Id returned by [Settings.Secure#ANDROID_ID](https://developer.android.com/reference/android/provider/Settings.Secure.html#ANDROID_ID). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 371 | pageSize: integer, The maximum number of DeviceUsers to return. If unspecified, at most 20 DeviceUsers will be returned. The maximum value is 20; values above 20 will be coerced to 20. |
| 372 | pageToken: string, A page token, received from a previous `LookupDeviceUsers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `LookupDeviceUsers` must match the call that provided the page token. |
| 373 | rawResourceId: string, Raw Resource Id used by Google Endpoint Verification. If the user is enrolled into Google Endpoint Verification, this id will be saved as the 'device_resource_id' field in the following platform dependent files. Mac: ~/.secureConnect/context_aware_config.json Windows: C:\Users\%USERPROFILE%\.secureConnect\context_aware_config.json Linux: ~/.secureConnect/context_aware_config.json |
| 374 | userId: string, The user whose DeviceUser's resource name will be fetched. Must be set to 'me' to fetch the DeviceUser's resource name for the calling user. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 375 | x__xgafv: string, V1 error format. |
| 376 | Allowed values |
| 377 | 1 - v1 error format |
| 378 | 2 - v2 error format |
| 379 | |
| 380 | Returns: |
| 381 | An object of the form: |
| 382 | |
| 383 | { # Response containing resource names of the DeviceUsers associated with the caller's credentials. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 384 | "customer": "A String", # The obfuscated customer Id that may be passed back to other Devices API methods such as List, Get, etc. |
| 385 | "names": [ # [Resource names](https://cloud.google.com/apis/design/resource_names) of the DeviceUsers in the format: `devices/{device_id}/deviceUsers/{user_resource_id}`, where device_id is the unique ID assigned to a Device and user_resource_id is the unique user ID |
| 386 | "A String", |
| 387 | ], |
| 388 | "nextPageToken": "A String", # Token to retrieve the next page of results. Empty if there are no more results. |
| 389 | }</pre> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 390 | </div> |
| 391 | |
| 392 | <div class="method"> |
| 393 | <code class="details" id="lookup_next">lookup_next(previous_request, previous_response)</code> |
| 394 | <pre>Retrieves the next page of results. |
| 395 | |
| 396 | Args: |
| 397 | previous_request: The request for the previous page. (required) |
| 398 | previous_response: The response from the request for the previous page. (required) |
| 399 | |
| 400 | Returns: |
| 401 | A request object that you can call 'execute()' on to request the next |
| 402 | page. Returns None if there are no more items in the collection. |
| 403 | </pre> |
| 404 | </div> |
| 405 | |
| 406 | <div class="method"> |
| 407 | <code class="details" id="wipe">wipe(name, body=None, x__xgafv=None)</code> |
| 408 | <pre>Wipes the user's account on a device. |
| 409 | |
| 410 | Args: |
| 411 | name: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}/deviceUsers/{device_user_id}`, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User. (required) |
| 412 | body: object, The request body. |
| 413 | The object takes the form of: |
| 414 | |
| 415 | { # Request message for starting an account wipe on device. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 416 | "customer": "A String", # Required. [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. |
| 417 | } |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 418 | |
| 419 | x__xgafv: string, V1 error format. |
| 420 | Allowed values |
| 421 | 1 - v1 error format |
| 422 | 2 - v2 error format |
| 423 | |
| 424 | Returns: |
| 425 | An object of the form: |
| 426 | |
| 427 | { # This resource represents a long-running operation that is the result of a network API call. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 428 | "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. |
| 429 | "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. |
| 430 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 431 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 432 | { |
| 433 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 434 | }, |
| 435 | ], |
| 436 | "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. |
| 437 | }, |
| 438 | "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. |
| 439 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 440 | }, |
| 441 | "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}`. |
| 442 | "response": { # The normal response of the operation in case of success. 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`. |
| 443 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 444 | }, |
| 445 | }</pre> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 446 | </div> |
| 447 | |
| 448 | </body></html> |