openapi-directory/api/googleapis.com/androidmanagement.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"contact":{"name":"Google","url":"https://google.com"},"description":"The Android Management API provides remote enterprise management of Android devices and apps.","title":"Android Management","version":"v1","x-apiClientRegistration":{"url":"https://console.developers.google.com"},"x-logo":{"url":"https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png"},"x-origin":[{"converter":{"url":"https://github.com/lucybot/api-spec-converter","version":"2.7.18"},"format":"google","url":"https://androidmanagement.googleapis.com/$discovery/rest?version=v1","version":"v1"}],"x-preferred":true,"x-providerName":"googleapis.com","x-serviceName":"androidmanagement"},"externalDocs":{"url":"https://developers.google.com/android/management"},"tags":[{"name":"enterprises"},{"name":"signupUrls"}],"paths":{"/v1/enterprises":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"post":{"description":"Creates an enterprise. This is the last step in the enterprise signup flow.","operationId":"androidmanagement.enterprises.create","parameters":[{"description":"The enterprise token appended to the callback URL.","in":"query","name":"enterpriseToken","schema":{"type":"string"}},{"description":"The ID of the Google Cloud Platform project which will own the enterprise.","in":"query","name":"projectId","schema":{"type":"string"}},{"description":"The name of the SignupUrl used to sign up for the enterprise.","in":"query","name":"signupUrlName","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Enterprise"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Enterprise"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/androidmanagement"]}],"tags":["enterprises"]}},"/v1/signupUrls":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"post":{"description":"Creates an enterprise signup URL.","operationId":"androidmanagement.signupUrls.create","parameters":[{"description":"The callback URL that the admin will be redirected to after successfully creating an enterprise. Before redirecting there the system will add a query parameter to this URL named enterpriseToken which will contain an opaque token to be used for the create enterprise request. The URL will be parsed then reformatted in order to add the enterpriseToken parameter, so there may be some minor formatting changes.","in":"query","name":"callbackUrl","schema":{"type":"string"}},{"description":"The ID of the Google Cloud Platform project which will own the enterprise.","in":"query","name":"projectId","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SignupUrl"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/androidmanagement"]}],"tags":["signupUrls"]}},"/v1/{name}":{"delete":{"description":"Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.","operationId":"androidmanagement.enterprises.devices.operations.delete","parameters":[{"description":"The name of the operation resource to be deleted.","in":"path","name":"name","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}},{"description":"Optional flags that control the device wiping behavior.","in":"query","name":"wipeDataFlags","explode":true,"schema":{"type":"array","items":{"enum":["WIPE_DATA_FLAG_UNSPECIFIED","PRESERVE_RESET_PROTECTION_DATA","WIPE_EXTERNAL_STORAGE"],"type":"string"}}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Empty"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/androidmanagement"]}],"tags":["enterprises"]},"get":{"description":"Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.","operationId":"androidmanagement.enterprises.devices.operations.get","parameters":[{"description":"The preferred language for localized application info, as a BCP47 tag (e.g. \"en-US\", \"de\"). If not specified the default language of the application will be used.","in":"query","name":"languageCode","schema":{"type":"string"}},{"description":"The name of the operation resource.","in":"path","name":"name","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Operation"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/androidmanagement"]}],"tags":["enterprises"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"patch":{"description":"Updates a device.","operationId":"androidmanagement.enterprises.devices.patch","parameters":[{"description":"The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.","in":"path","name":"name","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}},{"description":"The field mask indicating the fields to update. If not set, all modifiable fields will be modified.","in":"query","name":"updateMask","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Device"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Device"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/androidmanagement"]}],"tags":["enterprises"]}},"/v1/{name}:cancel":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"post":{"description":"Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.","operationId":"androidmanagement.enterprises.devices.operations.cancel","parameters":[{"description":"The name of the operation resource to be cancelled.","in":"path","name":"name","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Empty"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/androidmanagement"]}],"tags":["enterprises"]}},"/v1/{name}:issueCommand":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"post":{"description":"Issues a command to a device. The Operation resource returned contains a Command in its metadata field. Use the get operation method to get the status of the command.","operationId":"androidmanagement.enterprises.devices.issueCommand","parameters":[{"description":"The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.","in":"path","name":"name","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Command"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Operation"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/androidmanagement"]}],"tags":["enterprises"]}},"/v1/{parent}/devices":{"get":{"description":"Lists devices for a given enterprise.","operationId":"androidmanagement.enterprises.devices.list","parameters":[{"description":"The requested page size. The actual page size may be fixed to a min or max value.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"A token identifying a page of results returned by the server.","in":"query","name":"pageToken","schema":{"type":"string"}},{"description":"The name of the enterprise in the form enterprises/{enterpriseId}.","in":"path","name":"parent","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ListDevicesResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/androidmanagement"]}],"tags":["enterprises"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}]},"/v1/{parent}/enrollmentTokens":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"post":{"description":"Creates an enrollment token for a given enterprise.","operationId":"androidmanagement.enterprises.enrollmentTokens.create","parameters":[{"description":"The name of the enterprise in the form enterprises/{enterpriseId}.","in":"path","name":"parent","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentToken"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/EnrollmentToken"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/androidmanagement"]}],"tags":["enterprises"]}},"/v1/{parent}/policies":{"get":{"description":"Lists policies for a given enterprise.","operationId":"androidmanagement.enterprises.policies.list","parameters":[{"description":"The requested page size. The actual page size may be fixed to a min or max value.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"A token identifying a page of results returned by the server.","in":"query","name":"pageToken","schema":{"type":"string"}},{"description":"The name of the enterprise in the form enterprises/{enterpriseId}.","in":"path","name":"parent","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ListPoliciesResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/androidmanagement"]}],"tags":["enterprises"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}]},"/v1/{parent}/webTokens":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"post":{"description":"Creates a web token to access an embeddable managed Google Play web UI for a given enterprise.","operationId":"androidmanagement.enterprises.webTokens.create","parameters":[{"description":"The name of the enterprise in the form enterprises/{enterpriseId}.","in":"path","name":"parent","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebToken"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/WebToken"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/androidmanagement"]}],"tags":["enterprises"]}}},"servers":[{"url":"https://androidmanagement.googleapis.com/"}],"components":{"parameters":{"access_token":{"description":"OAuth access token.","in":"query","name":"access_token","schema":{"type":"string"}},"alt":{"description":"Data format for response.","in":"query","name":"alt","schema":{"type":"string","enum":["json","media","proto"],"default":"json"}},"callback":{"description":"JSONP","in":"query","name":"callback","schema":{"type":"string"}},"fields":{"description":"Selector specifying which fields to include in a partial response.","in":"query","name":"fields","schema":{"type":"string"}},"key":{"description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","in":"query","name":"key","schema":{"type":"string"}},"oauth_token":{"description":"OAuth 2.0 token for the current user.","in":"query","name":"oauth_token","schema":{"type":"string"}},"prettyPrint":{"description":"Returns response with indentations and line breaks.","in":"query","name":"prettyPrint","schema":{"type":"boolean","default":true}},"quotaUser":{"description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","in":"query","name":"quotaUser","schema":{"type":"string"}},"uploadType":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","in":"query","name":"uploadType","schema":{"type":"string"}},"upload_protocol":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","in":"query","name":"upload_protocol","schema":{"type":"string"}},"_.xgafv":{"description":"V1 error format.","in":"query","name":"$.xgafv","schema":{"type":"string","enum":["1","2"]}}},"securitySchemes":{"Oauth2":{"description":"Oauth 2.0 authentication","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://accounts.google.com/o/oauth2/auth","scopes":{"https://www.googleapis.com/auth/androidmanagement":"Manage Android devices and apps for your customers"}}}}},"schemas":{"AlwaysOnVpnPackage":{"description":"Configuration for an always-on VPN connection.","properties":{"lockdownEnabled":{"description":"Disallows networking when the VPN is not connected.","type":"boolean"},"packageName":{"description":"The package name of the VPN app.","type":"string"}},"type":"object"},"ApiLevelCondition":{"description":"A compliance rule condition which is satisfied if the Android Framework API level on the device doesn't meet a minimum requirement. There can only be one rule with this type of condition per policy.","properties":{"minApiLevel":{"description":"The minimum desired Android Framework API level. If the device doesn't meet the minimum requirement, this condition is satisfied. Must be greater than zero.","format":"int32","type":"integer"}},"type":"object"},"Application":{"description":"Information about an app.","properties":{"managedProperties":{"description":"The set of managed properties available to be pre-configured for the app.","items":{"$ref":"#/components/schemas/ManagedProperty"},"type":"array"},"name":{"description":"The name of the app in the form enterprises/{enterpriseId}/applications/{package_name}.","type":"string"},"permissions":{"description":"The permissions required by the app.","items":{"$ref":"#/components/schemas/ApplicationPermission"},"type":"array"},"title":{"description":"The title of the app. Localized.","type":"string"}},"type":"object"},"ApplicationEvent":{"description":"An app-related event.","properties":{"createTime":{"description":"The creation time of the event.","format":"google-datetime","type":"string"},"eventType":{"description":"App event type.","enum":["APPLICATION_EVENT_TYPE_UNSPECIFIED","INSTALLED","CHANGED","DATA_CLEARED","REMOVED","REPLACED","RESTARTED","PINNED","UNPINNED"],"type":"string"}},"type":"object"},"ApplicationPermission":{"description":"A permission required by the app.","properties":{"description":{"description":"A longer description of the permission, providing more detail on what it affects. Localized.","type":"string"},"name":{"description":"The name of the permission. Localized.","type":"string"},"permissionId":{"description":"An opaque string uniquely identifying the permission. Not localized.","type":"string"}},"type":"object"},"ApplicationPolicy":{"description":"Policy for an individual app.","properties":{"defaultPermissionPolicy":{"description":"The default policy for all permissions requested by the app. If specified, this overrides the policy-level default_permission_policy which applies to all apps. It does not override the permission_grants which applies to all apps.","enum":["PERMISSION_POLICY_UNSPECIFIED","PROMPT","GRANT","DENY"],"type":"string"},"delegatedScopes":{"description":"The scopes delegated to the app from Android Device Policy.","items":{"enum":["DELEGATED_SCOPE_UNSPECIFIED","CERT_INSTALL","MANAGED_CONFIGURATIONS","BLOCK_UNINSTALL","PERMISSION_GRANT","PACKAGE_ACCESS","ENABLE_SYSTEM_APP"],"type":"string"},"type":"array"},"disabled":{"description":"Whether the app is disabled. When disabled, the app data is still preserved.","type":"boolean"},"installType":{"description":"The type of installation to perform.","enum":["INSTALL_TYPE_UNSPECIFIED","PREINSTALLED","FORCE_INSTALLED","BLOCKED","AVAILABLE","REQUIRED_FOR_SETUP"],"type":"string"},"lockTaskAllowed":{"description":"Whether the app is allowed to lock itself in full-screen mode.","type":"boolean"},"managedConfiguration":{"additionalProperties":{"description":"Properties of the object."},"description":"Managed configuration applied to the app. The format for the configuration is dictated by the ManagedProperty values supported by the app. Each field name in the managed configuration must match the key field of the ManagedProperty. The field value must be compatible with the type of the ManagedProperty: <table> <tr><td><i>type</i></td><td><i>JSON value</i></td></tr> <tr><td>BOOL</td><td>true or false</td></tr> <tr><td>STRING</td><td>string</td></tr> <tr><td>INTEGER</td><td>number</td></tr> <tr><td>CHOICE</td><td>string</td></tr> <tr><td>MULTISELECT</td><td>array of strings</td></tr> <tr><td>HIDDEN</td><td>string</td></tr> <tr><td>BUNDLE_ARRAY</td><td>array of objects</td></tr> </table>","type":"object"},"managedConfigurationTemplate":{"$ref":"#/components/schemas/ManagedConfigurationTemplate"},"minimumVersionCode":{"description":"The minimum version of the app that runs on the device. If set, the device attempts to update the app to at least this version code. If the app is not up-to-date, the device will contain a NonComplianceDetail with non_compliance_reason set to APP_NOT_UPDATED. The app must already be published to Google Play with a version code greater than or equal to this value. At most 20 apps may specify a minimum version code per policy.","format":"int32","type":"integer"},"packageName":{"description":"The package name of the app. For example, com.google.android.youtube for the YouTube app.","type":"string"},"permissionGrants":{"description":"Explicit permission grants or denials for the app. These values override the default_permission_policy and permission_grants which apply to all apps.","items":{"$ref":"#/components/schemas/PermissionGrant"},"type":"array"}},"type":"object"},"ApplicationReport":{"description":"Information reported about an installed app.","properties":{"applicationSource":{"description":"The source of the package.","enum":["APPLICATION_SOURCE_UNSPECIFIED","SYSTEM_APP_FACTORY_VERSION","SYSTEM_APP_UPDATED_VERSION","INSTALLED_FROM_PLAY_STORE"],"type":"string"},"displayName":{"description":"The display name of the app.","type":"string"},"events":{"description":"List of app events. The most recent 20 events are stored in the list.","items":{"$ref":"#/components/schemas/ApplicationEvent"},"type":"array"},"installerPackageName":{"description":"The package name of the app that installed this app.","type":"string"},"packageName":{"description":"Package name of the app.","type":"string"},"packageSha256Hash":{"description":"The SHA-256 hash of the app's APK file, which can be used to verify the app hasn't been modified. Each byte of the hash value is represented as a two-digit hexadecimal number.","type":"string"},"signingKeyCertFingerprints":{"description":"The SHA-1 hash of each android.content.pm.Signature (https://developer.android.com/reference/android/content/pm/Signature.html) associated with the app package. Each byte of each hash value is represented as a two-digit hexadecimal number.","items":{"type":"string"},"type":"array"},"state":{"description":"Application state.","enum":["INSTALLED","REMOVED"],"type":"string"},"versionCode":{"description":"The app version code, which can be used to determine whether one version is more recent than another.","format":"int32","type":"integer"},"versionName":{"description":"The app version as displayed to the user.","type":"string"}},"type":"object"},"ChoosePrivateKeyRule":{"description":"A rule for automatically choosing a private key and certificate to authenticate the device to a server.","properties":{"packageNames":{"description":"The package names for which outgoing requests are subject to this rule. If no package names are specified, then the rule applies to all packages. For each package name listed, the rule applies to that package and all other packages that shared the same Android UID. The SHA256 hash of the signing key signatures of each package_name will be verified against those provided by Play","items":{"type":"string"},"type":"array"},"privateKeyAlias":{"description":"The alias of the private key to be used.","type":"string"},"urlPattern":{"description":"The URL pattern to match against the URL of the outgoing request. The pattern may contain asterisk (*) wildcards. Any URL is matched if unspecified.","type":"string"}},"type":"object"},"Command":{"description":"A command.","properties":{"createTime":{"description":"The timestamp at which the command was created. The timestamp is automatically generated by the server.","format":"google-datetime","type":"string"},"duration":{"description":"The duration for which the command is valid. The command will expire if not executed by the device during this time. The default duration if unspecified is ten minutes. There is no maximum duration.","format":"google-duration","type":"string"},"errorCode":{"description":"If the command failed, an error code explaining the failure. This is not set when the command is cancelled by the caller.","enum":["COMMAND_ERROR_CODE_UNSPECIFIED","UNKNOWN","API_LEVEL","MANAGEMENT_MODE","INVALID_VALUE","UNSUPPORTED"],"type":"string"},"newPassword":{"description":"For commands of type RESET_PASSWORD, optionally specifies the new password.","type":"string"},"resetPasswordFlags":{"description":"For commands of type RESET_PASSWORD, optionally specifies flags.","items":{"enum":["RESET_PASSWORD_FLAG_UNSPECIFIED","REQUIRE_ENTRY","DO_NOT_ASK_CREDENTIALS_ON_BOOT","LOCK_NOW"],"type":"string"},"type":"array"},"type":{"description":"The type of the command.","enum":["COMMAND_TYPE_UNSPECIFIED","LOCK","RESET_PASSWORD","REBOOT"],"type":"string"},"userName":{"description":"The resource name of the user that owns the device in the form enterprises/{enterpriseId}/users/{userId}. This is automatically generated by the server based on the device the command is sent to.","type":"string"}},"type":"object"},"ComplianceRule":{"description":"A rule declaring which mitigating actions to take when a device is not compliant with its policy. For every rule, there is always an implicit mitigating action to set policy_compliant to false for the Device resource, and display a message on the device indicating that the device is not compliant with its policy. Other mitigating actions may optionally be taken as well, depending on the field values in the rule.","properties":{"apiLevelCondition":{"$ref":"#/components/schemas/ApiLevelCondition"},"disableApps":{"description":"If set to true, the rule includes a mitigating action to disable apps so that the device is effectively disabled, but app data is preserved. If the device is running an app in locked task mode, the app will be closed and a UI showing the reason for non-compliance will be displayed.","type":"boolean"},"nonComplianceDetailCondition":{"$ref":"#/components/schemas/NonComplianceDetailCondition"},"packageNamesToDisable":{"description":"If set, the rule includes a mitigating action to disable apps specified in the list, but app data is preserved.","items":{"type":"string"},"type":"array"}},"type":"object"},"Device":{"description":"A device owned by an enterprise. Unless otherwise noted, all fields are read-only and can't be modified by enterprises.devices.patch.","properties":{"apiLevel":{"description":"The API level of the Android platform version running on the device.","format":"int32","type":"integer"},"applicationReports":{"description":"Reports for apps installed on the device. This information is only available when application_reports_enabled is true in the device's policy.","items":{"$ref":"#/components/schemas/ApplicationReport"},"type":"array"},"appliedPolicyName":{"description":"The name of the policy currently applied to the device.","type":"string"},"appliedPolicyVersion":{"description":"The version of the policy currently applied to the device.","format":"int64","type":"string"},"appliedState":{"description":"The state currently applied to the device.","enum":["DEVICE_STATE_UNSPECIFIED","ACTIVE","DISABLED","DELETED","PROVISIONING"],"type":"string"},"deviceSettings":{"$ref":"#/components/schemas/DeviceSettings"},"disabledReason":{"$ref":"#/components/schemas/UserFacingMessage"},"displays":{"description":"Detailed information about displays on the device. This information is only available if displayInfoEnabled is true in the device's policy.","items":{"$ref":"#/components/schemas/Display"},"type":"array"},"enrollmentTime":{"description":"The time of device enrollment.","format":"google-datetime","type":"string"},"enrollmentTokenData":{"description":"If the device was enrolled with an enrollment token with additional data provided, this field contains that data.","type":"string"},"enrollmentTokenName":{"description":"If the device was enrolled with an enrollment token, this field contains the name of the token.","type":"string"},"hardwareInfo":{"$ref":"#/components/schemas/HardwareInfo"},"hardwareStatusSamples":{"description":"Hardware status samples in chronological order. This information is only available if hardwareStatusEnabled is true in the device's policy.","items":{"$ref":"#/components/schemas/HardwareStatus"},"type":"array"},"lastPolicyComplianceReportTime":{"description":"Deprecated.","format":"google-datetime","type":"string"},"lastPolicySyncTime":{"description":"The last time the device fetched its policy.","format":"google-datetime","type":"string"},"lastStatusReportTime":{"description":"The last time the device sent a status report.","format":"google-datetime","type":"string"},"managementMode":{"description":"The type of management mode Android Device Policy takes on the device. This influences which policy settings are supported.","enum":["MANAGEMENT_MODE_UNSPECIFIED","DEVICE_OWNER","PROFILE_OWNER"],"type":"string"},"memoryEvents":{"description":"Events related to memory and storage measurements in chronological order. This information is only available if memoryInfoEnabled is true in the device's policy.","items":{"$ref":"#/components/schemas/MemoryEvent"},"type":"array"},"memoryInfo":{"$ref":"#/components/schemas/MemoryInfo"},"name":{"description":"The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.","type":"string"},"networkInfo":{"$ref":"#/components/schemas/NetworkInfo"},"nonComplianceDetails":{"description":"Details about policy settings that the device is not compliant with.","items":{"$ref":"#/components/schemas/NonComplianceDetail"},"type":"array"},"policyCompliant":{"description":"Whether the device is compliant with its policy.","type":"boolean"},"policyName":{"description":"The name of the policy applied to the device, in the form enterprises/{enterpriseId}/policies/{policyId}. If not specified, the policy_name for the device's user is applied. This field can be modified by a patch request. You can specify only the policyId when calling enterprises.devices.patch, as long as the policyId doesn’t contain any slashes. The rest of the policy name is inferred.","type":"string"},"powerManagementEvents":{"description":"Power management events on the device in chronological order. This information is only available if powerManagementEventsEnabled is true in the device's policy.","items":{"$ref":"#/components/schemas/PowerManagementEvent"},"type":"array"},"previousDeviceNames":{"description":"If the same physical device has been enrolled multiple times, this field contains its previous device names. The serial number is used as the unique identifier to determine if the same physical device has enrolled previously. The names are in chronological order.","items":{"type":"string"},"type":"array"},"softwareInfo":{"$ref":"#/components/schemas/SoftwareInfo"},"state":{"description":"The state to be applied to the device. This field can be modified by a patch request. Note that when calling enterprises.devices.patch, ACTIVE and DISABLED are the only allowable values. To enter the device into a DELETED state, call enterprises.devices.delete.","enum":["DEVICE_STATE_UNSPECIFIED","ACTIVE","DISABLED","DELETED","PROVISIONING"],"type":"string"},"user":{"$ref":"#/components/schemas/User"},"userName":{"description":"The resource name of the user that owns this device in the form enterprises/{enterpriseId}/users/{userId}.","type":"string"}},"type":"object"},"DeviceSettings":{"description":"Information about security related device settings on device.","properties":{"adbEnabled":{"description":"Whether ADB (https://developer.android.com/studio/command-line/adb.html) is enabled on the device.","type":"boolean"},"developmentSettingsEnabled":{"description":"Whether developer mode is enabled on the device.","type":"boolean"},"encryptionStatus":{"description":"Encryption status from DevicePolicyManager.","enum":["ENCRYPTION_STATUS_UNSPECIFIED","UNSUPPORTED","INACTIVE","ACTIVATING","ACTIVE","ACTIVE_DEFAULT_KEY","ACTIVE_PER_USER"],"type":"string"},"isDeviceSecure":{"description":"Whether the device is secured with PIN/password.","type":"boolean"},"isEncrypted":{"description":"Whether the storage encryption is enabled.","type":"boolean"},"unknownSourcesEnabled":{"description":"Whether installing apps from unknown sources is enabled.","type":"boolean"},"verifyAppsEnabled":{"description":"Whether Verify Apps (Google Play Protect (https://support.google.com/googleplay/answer/2812853)) is enabled on the device.","type":"boolean"}},"type":"object"},"Display":{"description":"Device display information.","properties":{"density":{"description":"Display density expressed as dots-per-inch.","format":"int32","type":"integer"},"displayId":{"description":"Unique display id.","format":"int32","type":"integer"},"height":{"description":"Display height in pixels.","format":"int32","type":"integer"},"name":{"description":"Name of the display.","type":"string"},"refreshRate":{"description":"Refresh rate of the display in frames per second.","format":"int32","type":"integer"},"state":{"description":"State of the display.","enum":["DISPLAY_STATE_UNSPECIFIED","OFF","ON","DOZE","SUSPENDED"],"type":"string"},"width":{"description":"Display width in pixels.","format":"int32","type":"integer"}},"type":"object"},"Empty":{"description":"A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:\nservice Foo {\n  rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.","properties":{},"type":"object"},"EnrollmentToken":{"description":"An enrollment token.","properties":{"additionalData":{"description":"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.","type":"string"},"duration":{"description":"The length of time the enrollment token is valid, ranging from 1 minute to 30 days. If not specified, the default duration is 1 hour.","format":"google-duration","type":"string"},"expirationTimestamp":{"description":"The expiration time of the token. This is a read-only field generated by the server.","format":"google-datetime","type":"string"},"name":{"description":"The name of the enrollment token, which is generated by the server during creation, in the form enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId}.","type":"string"},"oneTimeOnly":{"description":"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.","type":"boolean"},"policyName":{"description":"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.","type":"string"},"qrCode":{"description":"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.","type":"string"},"user":{"$ref":"#/components/schemas/User"},"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.","type":"string"}},"type":"object"},"Enterprise":{"description":"The configuration applied to an enterprise.","properties":{"appAutoApprovalEnabled":{"description":"Deprecated and unused.","type":"boolean"},"enabledNotificationTypes":{"description":"The types of Google Pub/Sub notifications enabled for the enterprise.","items":{"enum":["NOTIFICATION_TYPE_UNSPECIFIED","ENROLLMENT","COMPLIANCE_REPORT","STATUS_REPORT","COMMAND"],"type":"string"},"type":"array"},"enterpriseDisplayName":{"description":"The name of the enterprise displayed to users.","type":"string"},"logo":{"$ref":"#/components/schemas/ExternalData"},"name":{"description":"The name of the enterprise which is generated by the server during creation, in the form enterprises/{enterpriseId}.","type":"string"},"primaryColor":{"description":"A color in RGB format that indicates the predominant color to display in the device management app UI. The color components are stored as follows: (red << 16) | (green << 8) | blue, where the value of each component is between 0 and 255, inclusive.","format":"int32","type":"integer"},"pubsubTopic":{"description":"The topic that Cloud Pub/Sub notifications are published to, in the form projects/{project}/topics/{topic}. This field is only required if Pub/Sub notifications are enabled.","type":"string"},"signinDetails":{"description":"Sign-in details of the enterprise. Maximum of 1 SigninDetail is supported.","items":{"$ref":"#/components/schemas/SigninDetail"},"type":"array"},"termsAndConditions":{"description":"Terms and conditions that must be accepted when provisioning a device for this enterprise. A page of terms is generated for each value in this list.","items":{"$ref":"#/components/schemas/TermsAndConditions"},"type":"array"}},"type":"object"},"ExternalData":{"description":"Data hosted at an external location. The data is to be downloaded by Android Device Policy and verified against the hash.","properties":{"sha256Hash":{"description":"The base-64 encoded SHA-256 hash of the content hosted at url. If the content doesn't match this hash, Android Device Policy won't use the data.","type":"string"},"url":{"description":"The absolute URL to the data, which must use either the http or https scheme. Android Device Policy doesn't provide any credentials in the GET request, so the URL must be publicly accessible. Including a long, random component in the URL may be used to prevent attackers from discovering the URL.","type":"string"}},"type":"object"},"HardwareInfo":{"description":"Information about device hardware. The fields related to temperature thresholds are only available if hardwareStatusEnabled is true in the device's policy.","properties":{"batteryShutdownTemperatures":{"description":"Battery shutdown temperature thresholds in Celsius for each battery on the device.","items":{"format":"float","type":"number"},"type":"array"},"batteryThrottlingTemperatures":{"description":"Battery throttling temperature thresholds in Celsius for each battery on the device.","items":{"format":"float","type":"number"},"type":"array"},"brand":{"description":"Brand of the device. For example, Google.","type":"string"},"cpuShutdownTemperatures":{"description":"CPU shutdown temperature thresholds in Celsius for each CPU on the device.","items":{"format":"float","type":"number"},"type":"array"},"cpuThrottlingTemperatures":{"description":"CPU throttling temperature thresholds in Celsius for each CPU on the device.","items":{"format":"float","type":"number"},"type":"array"},"deviceBasebandVersion":{"description":"Baseband version. For example, MDM9625_104662.22.05.34p.","type":"string"},"gpuShutdownTemperatures":{"description":"GPU shutdown temperature thresholds in Celsius for each GPU on the device.","items":{"format":"float","type":"number"},"type":"array"},"gpuThrottlingTemperatures":{"description":"GPU throttling temperature thresholds in Celsius for each GPU on the device.","items":{"format":"float","type":"number"},"type":"array"},"hardware":{"description":"Name of the hardware. For example, Angler.","type":"string"},"manufacturer":{"description":"Manufacturer. For example, Motorola.","type":"string"},"model":{"description":"The model of the device. For example, Asus Nexus 7.","type":"string"},"serialNumber":{"description":"The device serial number.","type":"string"},"skinShutdownTemperatures":{"description":"Device skin shutdown temperature thresholds in Celsius.","items":{"format":"float","type":"number"},"type":"array"},"skinThrottlingTemperatures":{"description":"Device skin throttling temperature thresholds in Celsius.","items":{"format":"float","type":"number"},"type":"array"}},"type":"object"},"HardwareStatus":{"description":"Hardware status. Temperatures may be compared to the temperature thresholds available in hardwareInfo to determine hardware health.","properties":{"batteryTemperatures":{"description":"Current battery temperatures in Celsius for each battery on the device.","items":{"format":"float","type":"number"},"type":"array"},"cpuTemperatures":{"description":"Current CPU temperatures in Celsius for each CPU on the device.","items":{"format":"float","type":"number"},"type":"array"},"cpuUsages":{"description":"CPU usages in percentage for each core available on the device. Usage is 0 for each unplugged core. Empty array implies that CPU usage is not supported in the system.","items":{"format":"float","type":"number"},"type":"array"},"createTime":{"description":"The time the measurements were taken.","format":"google-datetime","type":"string"},"fanSpeeds":{"description":"Fan speeds in RPM for each fan on the device. Empty array means that there are no fans or fan speed is not supported on the system.","items":{"format":"float","type":"number"},"type":"array"},"gpuTemperatures":{"description":"Current GPU temperatures in Celsius for each GPU on the device.","items":{"format":"float","type":"number"},"type":"array"},"skinTemperatures":{"description":"Current device skin temperatures in Celsius.","items":{"format":"float","type":"number"},"type":"array"}},"type":"object"},"LaunchAppAction":{"description":"An action to launch an app.","properties":{"packageName":{"description":"Package name of app to be launched","type":"string"}},"type":"object"},"ListDevicesResponse":{"description":"Response to a request to list devices for a given enterprise.","properties":{"devices":{"description":"The list of devices.","items":{"$ref":"#/components/schemas/Device"},"type":"array"},"nextPageToken":{"description":"If there are more results, a token to retrieve next page of results.","type":"string"}},"type":"object"},"ListOperationsResponse":{"description":"The response message for Operations.ListOperations.","properties":{"nextPageToken":{"description":"The standard List next-page token.","type":"string"},"operations":{"description":"A list of operations that matches the specified filter in the request.","items":{"$ref":"#/components/schemas/Operation"},"type":"array"}},"type":"object"},"ListPoliciesResponse":{"description":"Response to a request to list policies for a given enterprise.","properties":{"nextPageToken":{"description":"If there are more results, a token to retrieve next page of results.","type":"string"},"policies":{"description":"The list of policies.","items":{"$ref":"#/components/schemas/Policy"},"type":"array"}},"type":"object"},"ManagedConfigurationTemplate":{"description":"The managed configurations template for the app, saved from the managed configurations iframe.","properties":{"configurationVariables":{"additionalProperties":{"type":"string"},"description":"Optional, a map containing <key, value> configuration variables defined for the configuration.","type":"object"},"templateId":{"description":"The ID of the managed configurations template.","type":"string"}},"type":"object"},"ManagedProperty":{"description":"Managed property.","properties":{"defaultValue":{"description":"The default value of the property. BUNDLE_ARRAY properties don't have a default value."},"description":{"description":"A longer description of the property, providing more detail of what it affects. Localized.","type":"string"},"entries":{"description":"For CHOICE or MULTISELECT properties, the list of possible entries.","items":{"$ref":"#/components/schemas/ManagedPropertyEntry"},"type":"array"},"key":{"description":"The unique key that the app uses to identify the property, e.g. \"com.google.android.gm.fieldname\".","type":"string"},"nestedProperties":{"description":"For BUNDLE_ARRAY properties, the list of nested properties. A BUNDLE_ARRAY property is at most two levels deep.","items":{"$ref":"#/components/schemas/ManagedProperty"},"type":"array"},"title":{"description":"The name of the property. Localized.","type":"string"},"type":{"description":"The type of the property.","enum":["MANAGED_PROPERTY_TYPE_UNSPECIFIED","BOOL","STRING","INTEGER","CHOICE","MULTISELECT","HIDDEN","BUNDLE_ARRAY"],"type":"string"}},"type":"object"},"ManagedPropertyEntry":{"description":"An entry of a managed property.","properties":{"name":{"description":"The human-readable name of the value. Localized.","type":"string"},"value":{"description":"The machine-readable value of the entry, which should be used in the configuration. Not localized.","type":"string"}},"type":"object"},"MemoryEvent":{"description":"An event related to memory and storage measurements.","properties":{"byteCount":{"description":"The number of free bytes in the medium, or for EXTERNAL_STORAGE_DETECTED, the total capacity in bytes of the storage medium.","format":"int64","type":"string"},"createTime":{"description":"The creation time of the event.","format":"google-datetime","type":"string"},"eventType":{"description":"Event type.","enum":["MEMORY_EVENT_TYPE_UNSPECIFIED","RAM_MEASURED","INTERNAL_STORAGE_MEASURED","EXTERNAL_STORAGE_DETECTED","EXTERNAL_STORAGE_REMOVED","EXTERNAL_STORAGE_MEASURED"],"type":"string"}},"type":"object"},"MemoryInfo":{"description":"Information about device memory and storage.","properties":{"totalInternalStorage":{"description":"Total internal storage on device in bytes.","format":"int64","type":"string"},"totalRam":{"description":"Total RAM on device in bytes.","format":"int64","type":"string"}},"type":"object"},"NetworkInfo":{"description":"Device network info.","properties":{"imei":{"description":"IMEI number of the GSM device. For example, A1000031212.","type":"string"},"meid":{"description":"MEID number of the CDMA device. For example, A00000292788E1.","type":"string"},"networkOperatorName":{"description":"Alphabetic name of current registered operator. For example, Vodafone.","type":"string"},"wifiMacAddress":{"description":"Wi-Fi MAC address of the device. For example, 7c:11:11:11:11:11.","type":"string"}},"type":"object"},"NonComplianceDetail":{"description":"Provides detail about non-compliance with a policy setting.","properties":{"currentValue":{"description":"If the policy setting could not be applied, the current value of the setting on the device."},"fieldPath":{"description":"For settings with nested fields, if a particular nested field is out of compliance, this specifies the full path to the offending field. The path is formatted in the same way the policy JSON field would be referenced in JavaScript, that is: 1) For object-typed fields, the field name is followed by a dot then by a  subfield name. 2) For array-typed fields, the field name is followed by the array index  enclosed in brackets. For example, to indicate a problem with the url field in the externalData field in the 3rd application, the path would be applications[2].externalData.url","type":"string"},"installationFailureReason":{"description":"If package_name is set and the non-compliance reason is APP_NOT_INSTALLED or APP_NOT_UPDATED, the detailed reason the app can't be installed or updated.","enum":["INSTALLATION_FAILURE_REASON_UNSPECIFIED","INSTALLATION_FAILURE_REASON_UNKNOWN","IN_PROGRESS","NOT_FOUND","NOT_COMPATIBLE_WITH_DEVICE","NOT_APPROVED","PERMISSIONS_NOT_ACCEPTED","NOT_AVAILABLE_IN_COUNTRY","NO_LICENSES_REMAINING","NOT_ENROLLED","USER_INVALID"],"type":"string"},"nonComplianceReason":{"description":"The reason the device is not in compliance with the setting.","enum":["NON_COMPLIANCE_REASON_UNSPECIFIED","API_LEVEL","MANAGEMENT_MODE","USER_ACTION","INVALID_VALUE","APP_NOT_INSTALLED","UNSUPPORTED","APP_INSTALLED","