You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dyn/androidmanagement_v1.enterprises.devices.html
+8-8Lines changed: 8 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -324,9 +324,9 @@ <h3>Method Details</h3>
324
324
"settingName": "A String", # The name of the policy setting. This is the JSON field name of a top-level Policy field.
325
325
"specificNonComplianceContext": { # Additional context for SpecificNonComplianceReason. # Additional context for specific_non_compliance_reason.
326
326
"oncWifiContext": { # Additional context for non-compliance related to Wi-Fi configuration. # Additional context for non-compliance related to Wi-Fi configuration. See ONC_WIFI_INVALID_VALUE.
327
-
"wifiGuid": "A String", # The guid of non-compliant Wi-Fi configuration.
327
+
"wifiGuid": "A String", # The GUID of non-compliant Wi-Fi configuration.
328
328
},
329
-
"passwordPoliciesContext": { # Additional context for non-compliance related to password policies. # Additional context for non-compliance related to password policies. See PASSWORD_POLICIES_PASSWORD_EXPIRED, and PASSWORD_POLICIES_PASSWORD_NOT_SUFFICIENT.
329
+
"passwordPoliciesContext": { # Additional context for non-compliance related to password policies. # Additional context for non-compliance related to password policies. See PASSWORD_POLICIES_PASSWORD_EXPIRED and PASSWORD_POLICIES_PASSWORD_NOT_SUFFICIENT.
330
330
"passwordPolicyScope": "A String", # The scope of non-compliant password.
331
331
},
332
332
},
@@ -649,9 +649,9 @@ <h3>Method Details</h3>
649
649
"settingName": "A String", # The name of the policy setting. This is the JSON field name of a top-level Policy field.
650
650
"specificNonComplianceContext": { # Additional context for SpecificNonComplianceReason. # Additional context for specific_non_compliance_reason.
651
651
"oncWifiContext": { # Additional context for non-compliance related to Wi-Fi configuration. # Additional context for non-compliance related to Wi-Fi configuration. See ONC_WIFI_INVALID_VALUE.
652
-
"wifiGuid": "A String", # The guid of non-compliant Wi-Fi configuration.
652
+
"wifiGuid": "A String", # The GUID of non-compliant Wi-Fi configuration.
653
653
},
654
-
"passwordPoliciesContext": { # Additional context for non-compliance related to password policies. # Additional context for non-compliance related to password policies. See PASSWORD_POLICIES_PASSWORD_EXPIRED, and PASSWORD_POLICIES_PASSWORD_NOT_SUFFICIENT.
654
+
"passwordPoliciesContext": { # Additional context for non-compliance related to password policies. # Additional context for non-compliance related to password policies. See PASSWORD_POLICIES_PASSWORD_EXPIRED and PASSWORD_POLICIES_PASSWORD_NOT_SUFFICIENT.
655
655
"passwordPolicyScope": "A String", # The scope of non-compliant password.
656
656
},
657
657
},
@@ -920,9 +920,9 @@ <h3>Method Details</h3>
920
920
"settingName": "A String", # The name of the policy setting. This is the JSON field name of a top-level Policy field.
921
921
"specificNonComplianceContext": { # Additional context for SpecificNonComplianceReason. # Additional context for specific_non_compliance_reason.
922
922
"oncWifiContext": { # Additional context for non-compliance related to Wi-Fi configuration. # Additional context for non-compliance related to Wi-Fi configuration. See ONC_WIFI_INVALID_VALUE.
923
-
"wifiGuid": "A String", # The guid of non-compliant Wi-Fi configuration.
923
+
"wifiGuid": "A String", # The GUID of non-compliant Wi-Fi configuration.
924
924
},
925
-
"passwordPoliciesContext": { # Additional context for non-compliance related to password policies. # Additional context for non-compliance related to password policies. See PASSWORD_POLICIES_PASSWORD_EXPIRED, and PASSWORD_POLICIES_PASSWORD_NOT_SUFFICIENT.
925
+
"passwordPoliciesContext": { # Additional context for non-compliance related to password policies. # Additional context for non-compliance related to password policies. See PASSWORD_POLICIES_PASSWORD_EXPIRED and PASSWORD_POLICIES_PASSWORD_NOT_SUFFICIENT.
926
926
"passwordPolicyScope": "A String", # The scope of non-compliant password.
927
927
},
928
928
},
@@ -1173,9 +1173,9 @@ <h3>Method Details</h3>
1173
1173
"settingName": "A String", # The name of the policy setting. This is the JSON field name of a top-level Policy field.
1174
1174
"specificNonComplianceContext": { # Additional context for SpecificNonComplianceReason. # Additional context for specific_non_compliance_reason.
1175
1175
"oncWifiContext": { # Additional context for non-compliance related to Wi-Fi configuration. # Additional context for non-compliance related to Wi-Fi configuration. See ONC_WIFI_INVALID_VALUE.
1176
-
"wifiGuid": "A String", # The guid of non-compliant Wi-Fi configuration.
1176
+
"wifiGuid": "A String", # The GUID of non-compliant Wi-Fi configuration.
1177
1177
},
1178
-
"passwordPoliciesContext": { # Additional context for non-compliance related to password policies. # Additional context for non-compliance related to password policies. See PASSWORD_POLICIES_PASSWORD_EXPIRED, and PASSWORD_POLICIES_PASSWORD_NOT_SUFFICIENT.
1178
+
"passwordPoliciesContext": { # Additional context for non-compliance related to password policies. # Additional context for non-compliance related to password policies. See PASSWORD_POLICIES_PASSWORD_EXPIRED and PASSWORD_POLICIES_PASSWORD_NOT_SUFFICIENT.
1179
1179
"passwordPolicyScope": "A String", # The scope of non-compliant password.
<pclass="firstline">Creates an enrollment token for a given enterprise.</p>
82
+
<pclass="firstline">Creates an enrollment token for a given enterprise. It's up to the caller's responsibility to manage the lifecycle of newly created tokens and deleting them when they're not intended to be used anymore. Once an enrollment token has been created, it's not possible to retrieve the token's content anymore using AM API. It is recommended for EMMs to securely store the token if it's intended to be reused.</p>
<pclass="firstline">Gets an active, unexpired enrollment token. Only a partial view of EnrollmentToken is returned: all the fields but name and expiration_timestamp are empty. This method is meant to help manage active enrollment tokens lifecycle. For security reasons, it's recommended to delete active enrollment tokens as soon as they're not intended to be used anymore.</p>
<pclass="firstline">Lists active, unexpired enrollment tokens for a given enterprise. The list items contain only a partial view of EnrollmentToken: all the fields but name and expiration_timestamp are empty. This method is meant to help manage active enrollment tokens lifecycle. For security reasons, it's recommended to delete active enrollment tokens as soon as they're not intended to be used anymore.</p>
<pre>Creates an enrollment token for a given enterprise.
103
+
<pre>Creates an enrollment token for a given enterprise. It's up to the caller's responsibility to manage the lifecycle of newly created tokens and deleting them when they're not intended to be used anymore. Once an enrollment token has been created, it's not possible to retrieve the token's content anymore using AM API. It is recommended for EMMs to securely store the token if it's intended to be reused.
95
104
96
105
Args:
97
106
parent: string, The name of the enterprise in the form enterprises/{enterpriseId}. (required)
<pre>Gets an active, unexpired enrollment token. Only a partial view of EnrollmentToken is returned: all the fields but name and expiration_timestamp are empty. This method is meant to help manage active enrollment tokens lifecycle. For security reasons, it's recommended to delete active enrollment tokens as soon as they're not intended to be used anymore.
170
+
171
+
Args:
172
+
name: string, Required. The name of the enrollment token in the form enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId}. (required)
173
+
x__xgafv: string, V1 error format.
174
+
Allowed values
175
+
1 - v1 error format
176
+
2 - v2 error format
177
+
178
+
Returns:
179
+
An object of the form:
180
+
181
+
{ # An enrollment token.
182
+
"additionalData": "A String", # Optional, arbitrary data associated with the enrollment token. This could contain, for example, the ID of an org unit the device is assigned to after enrollment. After a device enrolls with the token, this data will be exposed in the enrollment_token_data field of the Device resource. The data must be 1024 characters or less; otherwise, the creation request will fail.
183
+
"allowPersonalUsage": "A String", # Controls whether personal usage is allowed on a device provisioned with this enrollment token.For company-owned devices: Enabling personal usage allows the user to set up a work profile on the device. Disabling personal usage requires the user provision the device as a fully managed device.For personally-owned devices: Enabling personal usage allows the user to set up a work profile on the device. Disabling personal usage will prevent the device from provisioning. Personal usage cannot be disabled on personally-owned device.
184
+
"duration": "A String", # The length of time the enrollment token is valid, ranging from 1 minute to 90 days. If not specified, the default duration is 1 hour.
185
+
"expirationTimestamp": "A String", # The expiration time of the token. This is a read-only field generated by the server.
186
+
"name": "A String", # The name of the enrollment token, which is generated by the server during creation, in the form enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId}.
187
+
"oneTimeOnly": True or False, # Whether the enrollment token is for one time use only. If the flag is set to true, only one device can use it for registration.
188
+
"policyName": "A String", # The name of the policy initially applied to the enrolled device, in the form enterprises/{enterpriseId}/policies/{policyId}. If not specified, the policy_name for the device’s user is applied. If user_name is also not specified, enterprises/{enterpriseId}/policies/default is applied by default. When updating this field, you can specify only the policyId as long as the policyId doesn’t contain any slashes. The rest of the policy name will be inferred.
189
+
"qrCode": "A String", # A JSON string whose UTF-8 representation can be used to generate a QR code to enroll a device with this enrollment token. To enroll a device using NFC, the NFC record must contain a serialized java.util.Properties representation of the properties in the JSON.
190
+
"user": { # A user belonging to an enterprise. # The user associated with this enrollment token. If it's specified when the enrollment token is created and the user does not exist, the user will be created. This field must not contain personally identifiable information. Only the account_identifier field needs to be set.
191
+
"accountIdentifier": "A String", # A unique identifier you create for this user, such as user342 or asset#44418. This field must be set when the user is created and can't be updated. This field must not contain personally identifiable information (PII). This identifier must be 1024 characters or less; otherwise, the update policy request will fail.
192
+
},
193
+
"value": "A String", # The token value that's passed to the device and authorizes the device to enroll. This is a read-only field generated by the server.
<pre>Lists active, unexpired enrollment tokens for a given enterprise. The list items contain only a partial view of EnrollmentToken: all the fields but name and expiration_timestamp are empty. This method is meant to help manage active enrollment tokens lifecycle. For security reasons, it's recommended to delete active enrollment tokens as soon as they're not intended to be used anymore.
200
+
201
+
Args:
202
+
parent: string, Required. The name of the enterprise in the form enterprises/{enterpriseId}. (required)
203
+
pageSize: integer, The requested page size. The service may return fewer than this value. If unspecified, at most 10 items will be returned. The maximum value is 100; values above 100 will be coerced to 100.
204
+
pageToken: string, A token identifying a page of results returned by the server.
205
+
x__xgafv: string, V1 error format.
206
+
Allowed values
207
+
1 - v1 error format
208
+
2 - v2 error format
209
+
210
+
Returns:
211
+
An object of the form:
212
+
213
+
{ # Response to a request to list enrollment tokens for a given enterprise.
214
+
"enrollmentTokens": [ # The list of enrollment tokens.
215
+
{ # An enrollment token.
216
+
"additionalData": "A String", # Optional, arbitrary data associated with the enrollment token. This could contain, for example, the ID of an org unit the device is assigned to after enrollment. After a device enrolls with the token, this data will be exposed in the enrollment_token_data field of the Device resource. The data must be 1024 characters or less; otherwise, the creation request will fail.
217
+
"allowPersonalUsage": "A String", # Controls whether personal usage is allowed on a device provisioned with this enrollment token.For company-owned devices: Enabling personal usage allows the user to set up a work profile on the device. Disabling personal usage requires the user provision the device as a fully managed device.For personally-owned devices: Enabling personal usage allows the user to set up a work profile on the device. Disabling personal usage will prevent the device from provisioning. Personal usage cannot be disabled on personally-owned device.
218
+
"duration": "A String", # The length of time the enrollment token is valid, ranging from 1 minute to 90 days. If not specified, the default duration is 1 hour.
219
+
"expirationTimestamp": "A String", # The expiration time of the token. This is a read-only field generated by the server.
220
+
"name": "A String", # The name of the enrollment token, which is generated by the server during creation, in the form enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId}.
221
+
"oneTimeOnly": True or False, # Whether the enrollment token is for one time use only. If the flag is set to true, only one device can use it for registration.
222
+
"policyName": "A String", # The name of the policy initially applied to the enrolled device, in the form enterprises/{enterpriseId}/policies/{policyId}. If not specified, the policy_name for the device’s user is applied. If user_name is also not specified, enterprises/{enterpriseId}/policies/default is applied by default. When updating this field, you can specify only the policyId as long as the policyId doesn’t contain any slashes. The rest of the policy name will be inferred.
223
+
"qrCode": "A String", # A JSON string whose UTF-8 representation can be used to generate a QR code to enroll a device with this enrollment token. To enroll a device using NFC, the NFC record must contain a serialized java.util.Properties representation of the properties in the JSON.
224
+
"user": { # A user belonging to an enterprise. # The user associated with this enrollment token. If it's specified when the enrollment token is created and the user does not exist, the user will be created. This field must not contain personally identifiable information. Only the account_identifier field needs to be set.
225
+
"accountIdentifier": "A String", # A unique identifier you create for this user, such as user342 or asset#44418. This field must be set when the user is created and can't be updated. This field must not contain personally identifiable information (PII). This identifier must be 1024 characters or less; otherwise, the update policy request will fail.
226
+
},
227
+
"value": "A String", # The token value that's passed to the device and authorizes the device to enroll. This is a read-only field generated by the server.
228
+
},
229
+
],
230
+
"nextPageToken": "A String", # If there are more results, a token to retrieve next page of results.
0 commit comments