Skip to content

Commit

Permalink
feat(androidmanagement): update the api
Browse files Browse the repository at this point in the history
#### androidmanagement:v1

The following keys were added:
- schemas.EnrollmentToken.properties.user.deprecated (Total Keys: 1)
  • Loading branch information
yoshi-automation committed Apr 16, 2024
1 parent 81862bc commit 19577cc
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 16 deletions.
Expand Up @@ -116,7 +116,7 @@ <h3>Method Details</h3>
&quot;oneTimeOnly&quot;: 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.
&quot;policyName&quot;: &quot;A String&quot;, # 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鈥檚 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鈥檛 contain any slashes. The rest of the policy name will be inferred.
&quot;qrCode&quot;: &quot;A String&quot;, # 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.
&quot;user&quot;: { # A user belonging to an enterprise. # The user associated with this enrollment token. If it&#x27;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.
&quot;user&quot;: { # A user belonging to an enterprise. # This field is deprecated and the value is ignored.
&quot;accountIdentifier&quot;: &quot;A String&quot;, # 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&#x27;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.
},
&quot;value&quot;: &quot;A String&quot;, # The token value that&#x27;s passed to the device and authorizes the device to enroll. This is a read-only field generated by the server.
Expand All @@ -139,7 +139,7 @@ <h3>Method Details</h3>
&quot;oneTimeOnly&quot;: 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.
&quot;policyName&quot;: &quot;A String&quot;, # 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鈥檚 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鈥檛 contain any slashes. The rest of the policy name will be inferred.
&quot;qrCode&quot;: &quot;A String&quot;, # 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.
&quot;user&quot;: { # A user belonging to an enterprise. # The user associated with this enrollment token. If it&#x27;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.
&quot;user&quot;: { # A user belonging to an enterprise. # This field is deprecated and the value is ignored.
&quot;accountIdentifier&quot;: &quot;A String&quot;, # 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&#x27;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.
},
&quot;value&quot;: &quot;A String&quot;, # The token value that&#x27;s passed to the device and authorizes the device to enroll. This is a read-only field generated by the server.
Expand Down Expand Up @@ -187,7 +187,7 @@ <h3>Method Details</h3>
&quot;oneTimeOnly&quot;: 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.
&quot;policyName&quot;: &quot;A String&quot;, # 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鈥檚 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鈥檛 contain any slashes. The rest of the policy name will be inferred.
&quot;qrCode&quot;: &quot;A String&quot;, # 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.
&quot;user&quot;: { # A user belonging to an enterprise. # The user associated with this enrollment token. If it&#x27;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.
&quot;user&quot;: { # A user belonging to an enterprise. # This field is deprecated and the value is ignored.
&quot;accountIdentifier&quot;: &quot;A String&quot;, # 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&#x27;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.
},
&quot;value&quot;: &quot;A String&quot;, # The token value that&#x27;s passed to the device and authorizes the device to enroll. This is a read-only field generated by the server.
Expand Down Expand Up @@ -221,7 +221,7 @@ <h3>Method Details</h3>
&quot;oneTimeOnly&quot;: 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.
&quot;policyName&quot;: &quot;A String&quot;, # 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鈥檚 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鈥檛 contain any slashes. The rest of the policy name will be inferred.
&quot;qrCode&quot;: &quot;A String&quot;, # 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.
&quot;user&quot;: { # A user belonging to an enterprise. # The user associated with this enrollment token. If it&#x27;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.
&quot;user&quot;: { # A user belonging to an enterprise. # This field is deprecated and the value is ignored.
&quot;accountIdentifier&quot;: &quot;A String&quot;, # 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&#x27;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.
},
&quot;value&quot;: &quot;A String&quot;, # The token value that&#x27;s passed to the device and authorizes the device to enroll. This is a read-only field generated by the server.
Expand Down
14 changes: 7 additions & 7 deletions docs/dyn/androidmanagement_v1.enterprises.migrationTokens.html
Expand Up @@ -79,7 +79,7 @@ <h2>Instance Methods</h2>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a migration token, to migrate an existing device from being managed by the EMM's Device Policy Controller (DPC) to being managed by the Android Management API.</p>
<p class="firstline">Creates a migration token, to migrate an existing device from being managed by the EMM's Device Policy Controller (DPC) to being managed by the Android Management API. See the guide (https://developers.google.com/android/management/dpc-migration) for more details.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a migration token.</p>
Expand All @@ -97,14 +97,14 @@ <h3>Method Details</h3>

<div class="method">
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Creates a migration token, to migrate an existing device from being managed by the EMM&#x27;s Device Policy Controller (DPC) to being managed by the Android Management API.
<pre>Creates a migration token, to migrate an existing device from being managed by the EMM&#x27;s Device Policy Controller (DPC) to being managed by the Android Management API. See the guide (https://developers.google.com/android/management/dpc-migration) for more details.

Args:
parent: string, Required. The enterprise in which this migration token will be created. Format: enterprises/{enterprise} (required)
parent: string, Required. The enterprise in which this migration token is created. This must be the same enterprise which already manages the device in the Play EMM API. Format: enterprises/{enterprise} (required)
body: object, The request body.
The object takes the form of:

{ # A token to initiate the migration of a device from being managed by a third-party DPC to being managed by Android Management API. A migration token is valid only for a single device.
{ # A token to initiate the migration of a device from being managed by a third-party DPC to being managed by Android Management API. A migration token is valid only for a single device. See the guide (https://developers.google.com/android/management/dpc-migration) for more details.
&quot;additionalData&quot;: &quot;A String&quot;, # Immutable. Optional EMM-specified additional data. Once the device is migrated this will be populated in the migrationAdditionalData field of the Device resource. This must be at most 1024 characters.
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this migration token was created.
&quot;device&quot;: &quot;A String&quot;, # Output only. Once this migration token is used to migrate a device, the name of the resulting Device resource will be populated here, in the form enterprises/{enterprise}/devices/{device}.
Expand All @@ -126,7 +126,7 @@ <h3>Method Details</h3>
Returns:
An object of the form:

{ # A token to initiate the migration of a device from being managed by a third-party DPC to being managed by Android Management API. A migration token is valid only for a single device.
{ # A token to initiate the migration of a device from being managed by a third-party DPC to being managed by Android Management API. A migration token is valid only for a single device. See the guide (https://developers.google.com/android/management/dpc-migration) for more details.
&quot;additionalData&quot;: &quot;A String&quot;, # Immutable. Optional EMM-specified additional data. Once the device is migrated this will be populated in the migrationAdditionalData field of the Device resource. This must be at most 1024 characters.
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this migration token was created.
&quot;device&quot;: &quot;A String&quot;, # Output only. Once this migration token is used to migrate a device, the name of the resulting Device resource will be populated here, in the form enterprises/{enterprise}/devices/{device}.
Expand Down Expand Up @@ -155,7 +155,7 @@ <h3>Method Details</h3>
Returns:
An object of the form:

{ # A token to initiate the migration of a device from being managed by a third-party DPC to being managed by Android Management API. A migration token is valid only for a single device.
{ # A token to initiate the migration of a device from being managed by a third-party DPC to being managed by Android Management API. A migration token is valid only for a single device. See the guide (https://developers.google.com/android/management/dpc-migration) for more details.
&quot;additionalData&quot;: &quot;A String&quot;, # Immutable. Optional EMM-specified additional data. Once the device is migrated this will be populated in the migrationAdditionalData field of the Device resource. This must be at most 1024 characters.
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this migration token was created.
&quot;device&quot;: &quot;A String&quot;, # Output only. Once this migration token is used to migrate a device, the name of the resulting Device resource will be populated here, in the form enterprises/{enterprise}/devices/{device}.
Expand Down Expand Up @@ -188,7 +188,7 @@ <h3>Method Details</h3>

{ # Response to a request to list migration tokens for a given enterprise.
&quot;migrationTokens&quot;: [ # The migration tokens from the specified enterprise.
{ # A token to initiate the migration of a device from being managed by a third-party DPC to being managed by Android Management API. A migration token is valid only for a single device.
{ # A token to initiate the migration of a device from being managed by a third-party DPC to being managed by Android Management API. A migration token is valid only for a single device. See the guide (https://developers.google.com/android/management/dpc-migration) for more details.
&quot;additionalData&quot;: &quot;A String&quot;, # Immutable. Optional EMM-specified additional data. Once the device is migrated this will be populated in the migrationAdditionalData field of the Device resource. This must be at most 1024 characters.
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this migration token was created.
&quot;device&quot;: &quot;A String&quot;, # Output only. Once this migration token is used to migrate a device, the name of the resulting Device resource will be populated here, in the form enterprises/{enterprise}/devices/{device}.
Expand Down
Expand Up @@ -703,7 +703,7 @@
"migrationTokens": {
"methods": {
"create": {
"description": "Creates a migration token, to migrate an existing device from being managed by the EMM's Device Policy Controller (DPC) to being managed by the Android Management API.",
"description": "Creates a migration token, to migrate an existing device from being managed by the EMM's Device Policy Controller (DPC) to being managed by the Android Management API. See the guide (https://developers.google.com/android/management/dpc-migration) for more details.",
"flatPath": "v1/enterprises/{enterprisesId}/migrationTokens",
"httpMethod": "POST",
"id": "androidmanagement.enterprises.migrationTokens.create",
Expand All @@ -712,7 +712,7 @@
],
"parameters": {
"parent": {
"description": "Required. The enterprise in which this migration token will be created. Format: enterprises/{enterprise}",
"description": "Required. The enterprise in which this migration token is created. This must be the same enterprise which already manages the device in the Play EMM API. Format: enterprises/{enterprise}",
"location": "path",
"pattern": "^enterprises/[^/]+$",
"required": true,
Expand Down Expand Up @@ -1163,7 +1163,7 @@
}
}
},
"revision": "20240402",
"revision": "20240408",
"rootUrl": "https://androidmanagement.googleapis.com/",
"schemas": {
"AdbShellCommandEvent": {
Expand Down Expand Up @@ -3036,7 +3036,8 @@
},
"user": {
"$ref": "User",
"description": "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."
"deprecated": true,
"description": "This field is deprecated and the value is ignored."
},
"value": {
"description": "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.",
Expand Down Expand Up @@ -4014,7 +4015,7 @@ false
"type": "object"
},
"MigrationToken": {
"description": "A token to initiate the migration of a device from being managed by a third-party DPC to being managed by Android Management API. A migration token is valid only for a single device.",
"description": "A token to initiate the migration of a device from being managed by a third-party DPC to being managed by Android Management API. A migration token is valid only for a single device. See the guide (https://developers.google.com/android/management/dpc-migration) for more details.",
"id": "MigrationToken",
"properties": {
"additionalData": {
Expand Down

0 comments on commit 19577cc

Please sign in to comment.