docs/dyn/androidenterprise_v1.devices.html - platform/external/python/google-api-python-client - Git at Google

 <html><body>
 <style>

 body, h1, h2, h3, div, span, p, pre, a {
   margin: 0;
   padding: 0;
   border: 0;
   font-weight: inherit;
   font-style: inherit;
   font-size: 100%;
   font-family: inherit;
   vertical-align: baseline;
 }

 body {
   font-size: 13px;
   padding: 1em;
 }

 h1 {
   font-size: 26px;
   margin-bottom: 1em;
 }

 h2 {
   font-size: 24px;
   margin-bottom: 1em;
 }

 h3 {
   font-size: 20px;
   margin-bottom: 1em;
   margin-top: 1em;
 }

 pre, code {
   line-height: 1.5;
   font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
 }

 pre {
   margin-top: 0.5em;
 }

 h1, h2, h3, p {
   font-family: Arial, sans serif;
 }

 h1, h2, h3 {
   border-bottom: solid #CCC 1px;
 }

 .toc_element {
   margin-top: 0.5em;
 }

 .firstline {
   margin-left: 2 em;
 }

 .method  {
   margin-top: 1em;
   border: solid 1px #CCC;
   padding: 1em;
   background: #EEE;
 }

 .details {
   font-weight: bold;
   font-size: 14px;
 }

 </style>

 <h1><a href="androidenterprise_v1.html">Google Play EMM API</a> . <a href="androidenterprise_v1.devices.html">devices</a></h1>
 <h2>Instance Methods</h2>
 <p class="toc_element">
   <code><a href="#get">get(enterpriseId, userId, deviceId)</a></code></p>
 <p class="firstline">Retrieves the details of a device.</p>
 <p class="toc_element">
   <code><a href="#getState">getState(enterpriseId, userId, deviceId)</a></code></p>
 <p class="firstline">Retrieves whether a device is enabled or disabled for access by the user to Google services. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services.</p>
 <p class="toc_element">
   <code><a href="#list">list(enterpriseId, userId)</a></code></p>
 <p class="firstline">Retrieves the IDs of all of a user's devices.</p>
 <p class="toc_element">
   <code><a href="#setState">setState(enterpriseId, userId, deviceId, body)</a></code></p>
 <p class="firstline">Sets whether a device is enabled or disabled for access by the user to Google services. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services.</p>
 <h3>Method Details</h3>
 <div class="method">
     <code class="details" id="get">get(enterpriseId, userId, deviceId)</code>
   <pre>Retrieves the details of a device.

 Args:
   enterpriseId: string, The ID of the enterprise. (required)
   userId: string, The ID of the user. (required)
   deviceId: string, The ID of the device. (required)

 Returns:
   An object of the form:

     { # A device resource represents a mobile device managed by the EMM and belonging to a specific enterprise user.
       #
       # This collection cannot be modified via the API; it is automatically populated as devices are set up to be managed.
     "kind": "androidenterprise#device", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#device".
     "managementType": "A String", # The mechanism by which this device is managed by the EMM. "managedDevice" means that the EMM's app is a device owner. "managedProfile" means that the EMM's app is the profile owner (and there is a separate personal profile which is not managed). "containerApp" means that the EMM's app is managing the Android for Work container app on the device. ?unmanagedProfile? means that the EMM?s app is managing a managed user on an unmanaged device
     "androidId": "A String", # The Google Play Services Android ID for the device encoded as a lowercase hex string, e.g. "123456789abcdef0".
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="getState">getState(enterpriseId, userId, deviceId)</code>
   <pre>Retrieves whether a device is enabled or disabled for access by the user to Google services. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services.

 Args:
   enterpriseId: string, The ID of the enterprise. (required)
   userId: string, The ID of the user. (required)
   deviceId: string, The ID of the device. (required)

 Returns:
   An object of the form:

     { # The state of a user's device, as accessed by the getState and setState methods on device resources.
       "kind": "androidenterprise#deviceState", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#deviceState".
       "accountState": "A String", # The state of the Google account on the device. "enabled" indicates that the Google account on the device can be used to access Google services (including Google Play), while "disabled" means that it cannot. A new device is initially in the "disabled" state.
     }</pre>
 </div>

 <div class="method">
     <code class="details" id="list">list(enterpriseId, userId)</code>
   <pre>Retrieves the IDs of all of a user's devices.

 Args:
   enterpriseId: string, The ID of the enterprise. (required)
   userId: string, The ID of the user. (required)

 Returns:
   An object of the form:

     { # The device resources for the user.
     "device": [ # A managed device.
       { # A device resource represents a mobile device managed by the EMM and belonging to a specific enterprise user.
           #
           # This collection cannot be modified via the API; it is automatically populated as devices are set up to be managed.
         "kind": "androidenterprise#device", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#device".
         "managementType": "A String", # The mechanism by which this device is managed by the EMM. "managedDevice" means that the EMM's app is a device owner. "managedProfile" means that the EMM's app is the profile owner (and there is a separate personal profile which is not managed). "containerApp" means that the EMM's app is managing the Android for Work container app on the device. ?unmanagedProfile? means that the EMM?s app is managing a managed user on an unmanaged device
         "androidId": "A String", # The Google Play Services Android ID for the device encoded as a lowercase hex string, e.g. "123456789abcdef0".
       },
     ],
     "kind": "androidenterprise#devicesListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#devicesListResponse".
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="setState">setState(enterpriseId, userId, deviceId, body)</code>
   <pre>Sets whether a device is enabled or disabled for access by the user to Google services. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services.

 Args:
   enterpriseId: string, The ID of the enterprise. (required)
   userId: string, The ID of the user. (required)
   deviceId: string, The ID of the device. (required)
   body: object, The request body. (required)
     The object takes the form of:

 { # The state of a user's device, as accessed by the getState and setState methods on device resources.
     "kind": "androidenterprise#deviceState", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#deviceState".
     "accountState": "A String", # The state of the Google account on the device. "enabled" indicates that the Google account on the device can be used to access Google services (including Google Play), while "disabled" means that it cannot. A new device is initially in the "disabled" state.
   }


 Returns:
   An object of the form:

     { # The state of a user's device, as accessed by the getState and setState methods on device resources.
       "kind": "androidenterprise#deviceState", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#deviceState".
       "accountState": "A String", # The state of the Google account on the device. "enabled" indicates that the Google account on the device can be used to access Google services (including Google Play), while "disabled" means that it cannot. A new device is initially in the "disabled" state.
     }</pre>
 </div>

 </body></html>
	<html><body>
	<style>

	body, h1, h2, h3, div, span, p, pre, a {
	margin: 0;
	padding: 0;
	border: 0;
	font-weight: inherit;
	font-style: inherit;
	font-size: 100%;
	font-family: inherit;
	vertical-align: baseline;
	}

	body {
	font-size: 13px;
	padding: 1em;
	}

	h1 {
	font-size: 26px;
	margin-bottom: 1em;
	}

	h2 {
	font-size: 24px;
	margin-bottom: 1em;
	}

	h3 {
	font-size: 20px;
	margin-bottom: 1em;
	margin-top: 1em;
	}

	pre, code {
	line-height: 1.5;
	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
	}

	pre {
	margin-top: 0.5em;
	}

	h1, h2, h3, p {
	font-family: Arial, sans serif;
	}

	h1, h2, h3 {
	border-bottom: solid #CCC 1px;
	}

	.toc_element {
	margin-top: 0.5em;
	}

	.firstline {
	margin-left: 2 em;
	}

	.method {
	margin-top: 1em;
	border: solid 1px #CCC;
	padding: 1em;
	background: #EEE;
	}

	.details {
	font-weight: bold;
	font-size: 14px;
	}

	</style>

	<h1><a href="androidenterprise_v1.html">Google Play EMM API</a> . <a href="androidenterprise_v1.devices.html">devices</a></h1>
	<h2>Instance Methods</h2>
	<p class="toc_element">
	<code><a href="#get">get(enterpriseId, userId, deviceId)</a></code></p>
	<p class="firstline">Retrieves the details of a device.</p>
	<p class="toc_element">
	<code><a href="#getState">getState(enterpriseId, userId, deviceId)</a></code></p>
	<p class="firstline">Retrieves whether a device is enabled or disabled for access by the user to Google services. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services.</p>
	<p class="toc_element">
	<code><a href="#list">list(enterpriseId, userId)</a></code></p>
	<p class="firstline">Retrieves the IDs of all of a user's devices.</p>
	<p class="toc_element">
	<code><a href="#setState">setState(enterpriseId, userId, deviceId, body)</a></code></p>
	<p class="firstline">Sets whether a device is enabled or disabled for access by the user to Google services. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services.</p>
	<h3>Method Details</h3>
	<div class="method">
	<code class="details" id="get">get(enterpriseId, userId, deviceId)</code>
	<pre>Retrieves the details of a device.

	Args:
	enterpriseId: string, The ID of the enterprise. (required)
	userId: string, The ID of the user. (required)
	deviceId: string, The ID of the device. (required)

	Returns:
	An object of the form:

	{ # A device resource represents a mobile device managed by the EMM and belonging to a specific enterprise user.
	#
	# This collection cannot be modified via the API; it is automatically populated as devices are set up to be managed.
	"kind": "androidenterprise#device", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#device".
	"managementType": "A String", # The mechanism by which this device is managed by the EMM. "managedDevice" means that the EMM's app is a device owner. "managedProfile" means that the EMM's app is the profile owner (and there is a separate personal profile which is not managed). "containerApp" means that the EMM's app is managing the Android for Work container app on the device. ?unmanagedProfile? means that the EMM?s app is managing a managed user on an unmanaged device
	"androidId": "A String", # The Google Play Services Android ID for the device encoded as a lowercase hex string, e.g. "123456789abcdef0".
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="getState">getState(enterpriseId, userId, deviceId)</code>
	<pre>Retrieves whether a device is enabled or disabled for access by the user to Google services. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services.

	Args:
	enterpriseId: string, The ID of the enterprise. (required)
	userId: string, The ID of the user. (required)
	deviceId: string, The ID of the device. (required)

	Returns:
	An object of the form:

	{ # The state of a user's device, as accessed by the getState and setState methods on device resources.
	"kind": "androidenterprise#deviceState", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#deviceState".
	"accountState": "A String", # The state of the Google account on the device. "enabled" indicates that the Google account on the device can be used to access Google services (including Google Play), while "disabled" means that it cannot. A new device is initially in the "disabled" state.
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="list">list(enterpriseId, userId)</code>
	<pre>Retrieves the IDs of all of a user's devices.

	Args:
	enterpriseId: string, The ID of the enterprise. (required)
	userId: string, The ID of the user. (required)

	Returns:
	An object of the form:

	{ # The device resources for the user.
	"device": [ # A managed device.
	{ # A device resource represents a mobile device managed by the EMM and belonging to a specific enterprise user.
	#
	# This collection cannot be modified via the API; it is automatically populated as devices are set up to be managed.
	"kind": "androidenterprise#device", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#device".
	"managementType": "A String", # The mechanism by which this device is managed by the EMM. "managedDevice" means that the EMM's app is a device owner. "managedProfile" means that the EMM's app is the profile owner (and there is a separate personal profile which is not managed). "containerApp" means that the EMM's app is managing the Android for Work container app on the device. ?unmanagedProfile? means that the EMM?s app is managing a managed user on an unmanaged device
	"androidId": "A String", # The Google Play Services Android ID for the device encoded as a lowercase hex string, e.g. "123456789abcdef0".
	},
	],
	"kind": "androidenterprise#devicesListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#devicesListResponse".
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="setState">setState(enterpriseId, userId, deviceId, body)</code>
	<pre>Sets whether a device is enabled or disabled for access by the user to Google services. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services.

	Args:
	enterpriseId: string, The ID of the enterprise. (required)
	userId: string, The ID of the user. (required)
	deviceId: string, The ID of the device. (required)
	body: object, The request body. (required)
	The object takes the form of:

	{ # The state of a user's device, as accessed by the getState and setState methods on device resources.
	"kind": "androidenterprise#deviceState", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#deviceState".
	"accountState": "A String", # The state of the Google account on the device. "enabled" indicates that the Google account on the device can be used to access Google services (including Google Play), while "disabled" means that it cannot. A new device is initially in the "disabled" state.
	}


	Returns:
	An object of the form:

	{ # The state of a user's device, as accessed by the getState and setState methods on device resources.
	"kind": "androidenterprise#deviceState", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#deviceState".
	"accountState": "A String", # The state of the Google account on the device. "enabled" indicates that the Google account on the device can be used to access Google services (including Google Play), while "disabled" means that it cannot. A new device is initially in the "disabled" state.
	}</pre>
	</div>

	</body></html>