openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 179 kB
JSON
{"openapi":"3.0.0","servers":[{"url":"https://androidmanagement.googleapis.com/"}],"info":{"contact":{"name":"Google","url":"https://google.com","x-twitter":"youtube"},"description":"The Android Management API provides remote enterprise management of Android devices and apps.","license":{"name":"Creative Commons Attribution 3.0","url":"http://creativecommons.org/licenses/by/3.0/"},"termsOfService":"https://developers.google.com/terms/","title":"Android Management API","version":"v1","x-apiClientRegistration":{"url":"https://console.developers.google.com"},"x-apisguru-categories":["analytics","media"],"x-logo":{"url":"https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png"},"x-origin":[{"converter":{"url":"https://github.com/mermade/oas-kit","version":"7.0.4"},"format":"google","url":"https://androidmanagement.googleapis.com/$discovery/rest?version=v1","version":"v1"}],"x-providerName":"googleapis.com","x-serviceName":"androidmanagement"},"externalDocs":{"url":"https://developers.google.com/android/management"},"tags":[{"name":"enterprises"},{"name":"provisioningInfo"},{"name":"signupUrls"}],"paths":{"/v1/enterprises":{"get":{"description":"Lists EMM-managed enterprises. Only BASIC fields are returned.","operationId":"androidmanagement.enterprises.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":"Required. The Cloud project ID of the EMM managing the enterprises.","in":"query","name":"projectId","schema":{"type":"string"}},{"description":"Specifies which Enterprise fields to return. This method only supports BASIC.","in":"query","name":"view","schema":{"enum":["ENTERPRISE_VIEW_UNSPECIFIED","BASIC"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListEnterprisesResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/androidmanagement"],"Oauth2c":["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/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Creates an enterprise. This is the last step in the enterprise signup flow. See also: SigninDetail","operationId":"androidmanagement.enterprises.create","parameters":[{"description":"Whether the enterprise admin has seen and agreed to the managed Google Play Agreement (https://www.android.com/enterprise/terms/). Do not set this field for any customer-managed enterprise (https://developers.google.com/android/management/create-enterprise#customer-managed_enterprises). Set this to field to true for all EMM-managed enterprises (https://developers.google.com/android/management/create-enterprise#emm-managed_enterprises).","in":"query","name":"agreementAccepted","schema":{"type":"boolean"}},{"description":"The enterprise token appended to the callback URL. Set this when creating a customer-managed enterprise (https://developers.google.com/android/management/create-enterprise#customer-managed_enterprises) and not when creating a deprecated EMM-managed enterprise (https://developers.google.com/android/management/create-enterprise#emm-managed_enterprises).","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. Set this when creating a customer-managed enterprise (https://developers.google.com/android/management/create-enterprise#customer-managed_enterprises) and not when creating a deprecated EMM-managed enterprise (https://developers.google.com/android/management/create-enterprise#emm-managed_enterprises).","in":"query","name":"signupUrlName","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Enterprise"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Enterprise"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/androidmanagement"],"Oauth2c":["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/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"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":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignupUrl"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/androidmanagement"],"Oauth2c":["https://www.googleapis.com/auth/androidmanagement"]}],"tags":["signupUrls"]}},"/v1/{name}":{"delete":{"description":"Deletes a web app.","operationId":"androidmanagement.enterprises.webApps.delete","parameters":[{"description":"The name of the web app in the form enterprises/{enterpriseId}/webApps/{packageName}.","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"Optional flags that control the device wiping behavior.","explode":true,"in":"query","name":"wipeDataFlags","schema":{"items":{"enum":["WIPE_DATA_FLAG_UNSPECIFIED","PRESERVE_RESET_PROTECTION_DATA","WIPE_EXTERNAL_STORAGE"],"type":"string"},"type":"array"},"style":"form"},{"description":"Optional. A short message displayed to the user before wiping the work profile on personal devices. This has no effect on company owned devices. The maximum message length is 200 characters.","in":"query","name":"wipeReasonMessage","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Empty"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/androidmanagement"],"Oauth2c":["https://www.googleapis.com/auth/androidmanagement"]}],"tags":["enterprises"]},"get":{"description":"Get the device provisioning information by the identifier provided in the sign-in url.","operationId":"androidmanagement.provisioningInfo.get","parameters":[{"description":"Required. The identifier that Android Device Policy passes to the 3P sign-in page in the form of provisioningInfo/{provisioning_info}.","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"The standard list filter.","in":"query","name":"filter","schema":{"type":"string"}},{"description":"The standard list page size.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"The standard list page token.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProvisioningInfo"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/androidmanagement"],"Oauth2c":["https://www.googleapis.com/auth/androidmanagement"]}],"tags":["provisioningInfo"]},"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/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"patch":{"description":"Updates a web app.","operationId":"androidmanagement.enterprises.webApps.patch","parameters":[{"description":"The name of the web app in the form enterprises/{enterpriseId}/webApps/{packageName}.","in":"path","name":"name","required":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/WebApp"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebApp"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/androidmanagement"],"Oauth2c":["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/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"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,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Empty"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/androidmanagement"],"Oauth2c":["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/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"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,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Command"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/androidmanagement"],"Oauth2c":["https://www.googleapis.com/auth/androidmanagement"]}],"tags":["enterprises"]}},"/v1/{parent}/devices":{"get":{"description":"Lists devices for a given enterprise. Deleted devices are not returned in the response.","operationId":"androidmanagement.enterprises.devices.list","parameters":[{"description":"The name of the enterprise in the form enterprises/{enterpriseId}.","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"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"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDevicesResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/androidmanagement"],"Oauth2c":["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/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/v1/{parent}/enrollmentTokens":{"get":{"description":"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.","operationId":"androidmanagement.enterprises.enrollmentTokens.list","parameters":[{"description":"Required. The name of the enterprise in the form enterprises/{enterpriseId}.","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"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.","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"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListEnrollmentTokensResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/androidmanagement"],"Oauth2c":["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/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"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.","operationId":"androidmanagement.enterprises.enrollmentTokens.create","parameters":[{"description":"The name of the enterprise in the form enterprises/{enterpriseId}.","in":"path","name":"parent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentToken"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollmentToken"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/androidmanagement"],"Oauth2c":["https://www.googleapis.com/auth/androidmanagement"]}],"tags":["enterprises"]}},"/v1/{parent}/migrationTokens":{"get":{"description":"Lists migration tokens.","operationId":"androidmanagement.enterprises.migrationTokens.list","parameters":[{"description":"Required. The enterprise which the migration tokens belong to. Format: enterprises/{enterprise}","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"The maximum number of migration tokens to return. Fewer migration tokens may be returned. If unspecified, at most 100 migration tokens will be returned. The maximum value is 100; values above 100 will be coerced to 100.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"A page token, received from a previous ListMigrationTokens call. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to ListMigrationTokens must match the call that provided the page token.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListMigrationTokensResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/androidmanagement"],"Oauth2c":["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/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"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.","operationId":"androidmanagement.enterprises.migrationTokens.create","parameters":[{"description":"Required. The enterprise in which this migration token will be created. Format: enterprises/{enterprise}","in":"path","name":"parent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MigrationToken"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MigrationToken"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/androidmanagement"],"Oauth2c":["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 name of the enterprise in the form enterprises/{enterpriseId}.","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"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"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPoliciesResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/androidmanagement"],"Oauth2c":["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/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/v1/{parent}/webApps":{"get":{"description":"Lists web apps for a given enterprise.","operationId":"androidmanagement.enterprises.webApps.list","parameters":[{"description":"The name of the enterprise in the form enterprises/{enterpriseId}.","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"The requested page size. This is a hint and the actual page size in the response may be different.","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"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWebAppsResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/androidmanagement"],"Oauth2c":["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/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Creates a web app.","operationId":"androidmanagement.enterprises.webApps.create","parameters":[{"description":"The name of the enterprise in the form enterprises/{enterpriseId}.","in":"path","name":"parent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebApp"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebApp"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/androidmanagement"],"Oauth2c":["https://www.googleapis.com/auth/androidmanagement"]}],"tags":["enterprises"]}},"/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/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"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,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebToken"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebToken"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/androidmanagement"],"Oauth2c":["https://www.googleapis.com/auth/androidmanagement"]}],"tags":["enterprises"]}}},"components":{"parameters":{"_.xgafv":{"description":"V1 error format.","in":"query","name":"$.xgafv","schema":{"enum":["1","2"],"type":"string"}},"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":{"enum":["json","media","proto"],"type":"string"}},"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"}},"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"}}},"schemas":{"AdbShellCommandEvent":{"description":"A shell command was issued over ADB via “adb shell command”.","properties":{"shellCmd":{"description":"Shell command that was issued over ADB via \"adb shell command\". Redacted to empty string on organization-owned managed profile devices.","type":"string"}},"type":"object"},"AdbShellInteractiveEvent":{"description":"An ADB interactive shell was opened via “adb shell”. Intentionally empty.","properties":{},"type":"object"},"AdvancedSecurityOverrides":{"description":"Advanced security settings. In most cases, setting these is not needed.","properties":{"commonCriteriaMode":{"description":"Controls Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC). Enabling Common Criteria Mode increases certain security components on a device, including AES-GCM encryption of Bluetooth Long Term Keys, and Wi-Fi configuration stores.Warning: Common Criteria Mode enforces a strict security model typically only required for IT products used in national security systems and other highly sensitive organizations. Standard device use may be affected. Only enabled if required.","enum":["COMMON_CRITERIA_MODE_UNSPECIFIED","COMMON_CRITERIA_MODE_DISABLED","COMMON_CRITERIA_MODE_ENABLED"],"type":"string"},"developerSettings":{"description":"Controls access to developer settings: developer options and safe boot. Replaces safeBootDisabled (deprecated) and debuggingFeaturesAllowed (deprecated).","enum":["DEVELOPER_SETTINGS_UNSPECIFIED","DEVELOPER_SETTINGS_DISABLED","DEVELOPER_SETTINGS_ALLOWED"],"type":"string"},"googlePlayProtectVerifyApps":{"description":"Whether Google Play Protect verification (https://support.google.com/accounts/answer/2812853) is enforced. Replaces ensureVerifyAppsEnabled (deprecated).","enum":["GOOGLE_PLAY_PROTECT_VERIFY_APPS_UNSPECIFIED","VERIFY_APPS_ENFORCED","VERIFY_APPS_USER_CHOICE"],"type":"string"},"mtePolicy":{"description":"Optional. Controls Memory Tagging Extension (MTE) (https://source.android.com/docs/security/test/memory-safety/arm-mte) on the device. The device needs to be rebooted to apply changes to the MTE policy.","enum":["MTE_POLICY_UNSPECIFIED","MTE_USER_CHOICE","MTE_ENFORCED","MTE_DISABLED"],"type":"string"},"personalAppsThatCanReadWorkNotifications":{"description":"Personal apps that can read work profile notifications using a NotificationListenerService (https://developer.android.com/reference/android/service/notification/NotificationListenerService). By default, no personal apps (aside from system apps) can read work notifications. Each value in the list must be a package name.","items":{"type":"string"},"type":"array"},"untrustedAppsPolicy":{"description":"The policy for untrusted apps (apps from unknown sources) enforced on the device. Replaces install_unknown_sources_allowed (deprecated).","enum":["UNTRUSTED_APPS_POLICY_UNSPECIFIED","DISALLOW_INSTALL","ALLOW_INSTALL_IN_PERSONAL_PROFILE_ONLY","ALLOW_INSTALL_DEVICE_WIDE"],"type":"string"}},"type":"object"},"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":{"deprecated":true,"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"},"AppProcessInfo":{"description":"Information about a process. It contains process name, start time, app Uid, app Pid, seinfo tag, hash of the base APK.","properties":{"apkSha256Hash":{"description":"SHA-256 hash of the base APK, in hexadecimal format.","type":"string"},"packageNames":{"description":"Package names of all packages that are associated with the particular user ID. In most cases, this will be a single package name, the package that has been assigned that user ID. If multiple application share a UID then all packages sharing UID will be included.","items":{"type":"string"},"type":"array"},"pid":{"description":"Process ID.","format":"int32","type":"integer"},"processName":{"description":"Process name.","type":"string"},"seinfo":{"description":"SELinux policy info.","type":"string"},"startTime":{"description":"Process start time.","format":"google-datetime","type":"string"},"uid":{"description":"UID of the package.","format":"int32","type":"integer"}},"type":"object"},"AppProcessStartEvent":{"description":"An app process was started. This is available device-wide on fully managed devices and within the work profile on organization-owned devices with a work profile.","properties":{"processInfo":{"$ref":"#/components/schemas/AppProcessInfo","description":"Information about a process."}},"type":"object"},"AppTrackInfo":{"description":"Id to name association of a app track.","properties":{"trackAlias":{"description":"The track name associated with the trackId, set in the Play Console. The name is modifiable from Play Console.","type":"string"},"trackId":{"description":"The unmodifiable unique track identifier, taken from the releaseTrackId in the URL of the Play Console page that displays the app’s track information.","type":"string"}},"type":"object"},"AppVersion":{"description":"This represents a single version of the app.","properties":{"production":{"description":"If the value is True, it indicates that this version is a production track.","type":"boolean"},"trackIds":{"description":"Track identifiers that the app version is published in. This does not include the production track (see production instead).","items":{"type":"string"},"type":"array"},"versionCode":{"description":"Unique increasing identifier for the app version.","format":"int32","type":"integer"},"versionString":{"description":"The string used in the Play store by the app developer to identify the version. The string is not necessarily unique or localized (for example, the string could be \"1.4\").","type":"string"}},"type":"object"},"Application":{"description":"Information about an app.","properties":{"appPricing":{"description":"Whether this app is free, free with in-app purchases, or paid. If the pricing is unspecified, this means the app is not generally available anymore (even though it might still be available to people who own it).","enum":["APP_PRICING_UNSPECIFIED","FREE","FREE_WITH_IN_APP_PURCHASE","PAID"],"type":"string"},"appTracks":{"description":"Application tracks visible to the enterprise.","items":{"$ref":"#/components/schemas/AppTrackInfo"},"type":"array"},"appVersions":{"description":"Versions currently available for this app.","items":{"$ref":"#/components/schemas/AppVersion"},"type":"array"},"author":{"description":"The name of the author of the apps (for example, the app developer).","type":"string"},"availableCountries":{"description":"The countries which this app is available in as per ISO 3166-1 alpha-2.","items":{"type":"string"},"type":"array"},"category":{"description":"The app category (e.g. RACING, SOCIAL, etc.)","type":"string"},"contentRating":{"description":"The content rating for this app.","enum":["CONTENT_RATING_UNSPECIFIED","THREE_YEARS","SEVEN_YEARS","TWELVE_YEARS","SIXTEEN_YEARS","EIGHTEEN_YEARS"],"type":"string"},"description":{"description":"The localized promotional description, if available.","type":"string"},"distributionChannel":{"description":"How and to whom the package is made available.","enum":["DISTRIBUTION_CHANNEL_UNSPECIFIED","PUBLIC_GOOGLE_HOSTED","PRIVATE_GOOGLE_HOSTED","PRIVATE_SELF_HOSTED"],"type":"string"},"features":{"description":"Noteworthy features (if any) of this app.","items":{"enum":["APP_FEATURE_UNSPECIFIED","VPN_APP"],"type":"string"},"type":"array"},"fullDescription":{"description":"Full app description, if available.","type":"string"},"iconUrl":{"description":"A link to an image that can be used as an icon for the app. This image is suitable for use up to a pixel size of 512 x 512.","type":"string"},"managedProperties":{"description":"The set of managed properties available to be pre-configured for the app.","items":{"$ref":"#/components/schemas/ManagedProperty"},"type":"array"},"minAndroidSdkVersion":{"description":"The minimum Android SDK necessary to run the app.","format":"int32","type":"integer"},"name":{"description":"The name of the app in the form enterprises/{enterprise}/applications/{package_name}.","type":"string"},"permissions":{"description":"The permissions required by the app.","items":{"$ref":"#/components/schemas/ApplicationPermission"},"type":"array"},"playStoreUrl":{"description":"A link to the (consumer) Google Play details page for the app.","type":"string"},"recentChanges":{"description":"A localised description of the recent changes made to the app.","type":"string"},"screenshotUrls":{"description":"A list of screenshot links representing the app.","items":{"type":"string"},"type":"array"},"smallIconUrl":{"description":"A link to a smaller image that can be used as an icon for the app. This image is suitable for use up to a pixel size of 128 x 128.","type":"string"},"title":{"description":"The title of the app. Localized.","type":"string"},"updateTime":{"description":"Output only. The approximate time (within 7 days) the app was last published.","format":"google-datetime","readOnly":true,"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. Note: Application availability on a given device cannot be changed using this policy if installAppsDisabled is enabled. The maximum number of applications that you can specify per policy is 3,000.","properties":{"accessibleTrackIds":{"description":"List of the app’s track IDs that a device belonging to the enterprise can access. If the list contains multiple track IDs, devices receive the latest version among all accessible tracks. If the list contains no track IDs, devices only have access to the app’s production track. More details about each track are available in AppTrackInfo.","items":{"type":"string"},"type":"array"},"alwaysOnVpnLockdownExemption":{"description":"Specifies whether the app is allowed networking when the VPN is not connected and alwaysOnVpnPackage.lockdownEnabled is enabled. If set to VPN_LOCKDOWN_ENFORCED, the app is not allowed networking, and if set to VPN_LOCKDOWN_EXEMPTION, the app is allowed networking. Only supported on devices running Android 10 and above. If this is not supported by the device, the device will contain a NonComplianceDetail with non_compliance_reason set to API_LEVEL and a fieldPath. If this is not applicable to the app, the device will contain a NonComplianceDetail with non_compliance_reason set to UNSUPPORTED and a fieldPath. The fieldPath is set to applications[i].alwaysOnVpnLockdownExemption, where i is the index of the package in the applications policy.","enum":["ALWAYS_ON_VPN_LOCKDOWN_EXEMPTION_UNSPECIFIED","VPN_LOCKDOWN_ENFORCED","VPN_LOCKDOWN_EXEMPTION"],"type":"string"},"autoUpdateMode":{"description":"Controls the auto-update mode for the app.","enum":["AUTO_UPDATE_MODE_UNSPECIFIED","AUTO_UPDATE_DEFAULT","AUTO_UPDATE_POSTPONED","AUTO_UPDATE_HIGH_PRIORITY"],"type":"string"},"connectedWorkAndPersonalApp":{"description":"Controls whether the app can communicate with itself across a device’s work and personal profiles, subject to user consent.","enum":["CONNECTED_WORK_AND_PERSONAL_APP_UNSPECIFIED","CONNECTED_WORK_AND_PERSONAL_APP_DISALLOWED","CONNECTED_WORK_AND_PERSONAL_APP_ALLOWED"],"type":"string"},"credentialProviderPolicy":{"description":"Optional. Whether the app is allowed to act as a credential provider on Android 14 and above.","enum":["CREDENTIAL_PROVIDER_POLICY_UNSPECIFIED","CREDENTIAL_PROVIDER_ALLOWED"],"type":"string"},"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. These provide additional privileges for the applications they are applied to.","items":{"enum":["DELEGATED_SCOPE_UNSPECIFIED","CERT_INSTALL","MANAGED_CONFIGURATIONS","BLOCK_UNINSTALL","PERMISSION_GRANT","PACKAGE_ACCESS","ENABLE_SYSTEM_APP","NETWORK_ACTIVITY_LOGS","SECURITY_LOGS","CERT_SELECTION"],"type":"string"},"type":"array"},"disabled":{"description":"Whether the app is disabled. When disabled, the app data is still preserved.","type":"boolean"},"extensionConfig":{"$ref":"#/components/schemas/ExtensionConfig","description":"Configuration to enable this app as an extension app, with the capability of interacting with Android Device Policy offline.This field can be set for at most one app."},"installConstraint":{"description":"Optional. The constraints for installing the app. You can specify a maximum of one InstallConstraint. Multiple constraints are rejected.","items":{"$ref":"#/components/schemas/InstallConstraint"},"type":"array"},"installPriority":{"description":"Optional. Amongst apps with installType set to: FORCE_INSTALLED PREINSTALLEDthis controls the relative priority of installation. A value of 0 (default) means this app has no priority over other apps. For values between 1 and 10,000, a lower value means a higher priority. Values outside of the range 0 to 10,000 inclusive are rejected.","format":"int32","type":"integer"},"installType":{"description":"The type of installation to perform.","enum":["INSTALL_TYPE_UNSPECIFIED","PREINSTALLED","FORCE_INSTALLED","BLOCKED","AVAILABLE","REQUIRED_FOR_SETUP","KIOSK"],"type":"string"},"lockTaskAllowed":{"deprecated":true,"description":"Whether the app is allowed to lock itself in full-screen mode. DEPRECATED. Use InstallType KIOSK or kioskCustomLauncherEnabled to configure a dedicated device.","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: *type* *JSON value* BOOL true or false STRING string INTEGER number CHOICE string MULTISELECT array of strings HIDDEN string BUNDLE_ARRAY array of objects ","type":"object"},"managedConfigurationTemplate":{"$ref":"#/components/schemas/ManagedConfigurationTemplate","description":"The managed configurations template for the app, saved from the managed configurations iframe. This field is ignored if managed_configuration is set."},"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"},"workProfileWidgets":{"description":"Specifies whether the app installed in the work profile is allowed to add widgets to the home screen.","enum":["WORK_PROFILE_WIDGETS_UNSPECIFIED","WORK_PROFILE_WIDGETS_ALLOWED","WORK_PROFILE_WIDGETS_DISALLOWED"],"type":"string"}},"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":"The list of app events which have occurred in the last 30 hours.","items":{"$ref":"#/components/schemas/ApplicationEvent"},"type":"array"},"installerPackageName":{"description":"The package name of the app that installed this app.","type":"string"},"keyedAppStates":{"description":"List of keyed app states reported by the app.","items":{"$ref":"#/components/schemas/KeyedAppState"},"type":"array"},"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":["APPLICATION_STATE_UNSPECIFIED","REMOVED","INSTALLED"],"type":"string"},"userFacingType":{"description":"Whether the app is user facing.","enum":["USER_FACING_TYPE_UNSPECIFIED","NOT_USER_FACING","USER_FACING"],"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"},"ApplicationReportingSettings":{"description":"Settings controlling the behavior of application reports.","properties":{"includeRemovedApps":{"description":"Whether removed apps are included in application reports.","type":"boolean"}},"type":"object"},"BatchUsageLogEvents":{"description":"Batched event logs of events from the device.","properties":{"device":{"description":"The name of the device in the form ‘enterprises/{enterpriseId}/devices/{deviceId}’","type":"string"},"retrievalTime":{"description":"The device timestamp when the batch of events were collected from the device.","format":"google-datetime","type":"string"},"usageLogEvents":{"description":"The list of UsageLogEvent that were reported by the device, sorted chronologically by the event time.","items":{"$ref":"#/components/schemas/UsageLogEvent"},"type":"array"},"user":{"description":"The resource name of the user that owns this device in the form ‘enterprises/{enterpriseId}/users/{userId}’.","type":"string"}},"type":"object"},"BlockAction":{"description":"An action to block access to apps and data on a fully managed device or in a work profile. This action also triggers a device or work profile to displays a user-facing notification with information (where possible) on how to correct the compliance issue. Note: wipeAction must also be specified.","properties":{"blockAfterDays":{"description":"Number of days the policy is non-compliant before the device or work profile is blocked. To block access immediately, set to 0. blockAfterDays must be less than wipeAfterDays.","format":"int32","type":"integer"},"blockScope":{"description":"Specifies the scope of this BlockAction. Only applicable to devices that are company-owned.","enum":["BLOCK_SCOPE_UNSPECIFIED","BLOCK_SCOPE_WORK_PROFILE","BLOCK_SCOPE_DEVICE"],"type":"string"}},"type":"object"},"CertAuthorityInstalledEvent":{"description":"A new root certificate was installed into the system's trusted credential storage. This is available device-wide on fully managed devices and within the work profile on organization-owned devices with a work profile.","properties":{"certificate":{"description":"Subject of the certificate.","type":"string"},"success":{"description":"Whether the installation event succeeded.","type":"boolean"},"userId":{"description":"The user in which the certificate install event happened. Only available for devices running Android 11 and above.","format":"int32","type":"integer"}},"type":"object"},"CertAuthorityRemovedEvent":{"description":"A root certificate was removed from the system's trusted credential storage. This is available device-wide on fully managed devices and within the work profile on organization-owned devices with a work profile.","properties":{"certificate":{"description":"Subject of the certificate.","type":"string"},"success":{"description":"Whether the removal succeeded.","type":"boolean"},"userId":{"description":"The user in which the certificate removal event occurred. Only available for devices running Android 11 and above.","format":"int32","type":"integer"}},"type":"object"},"CertValidationFailureEvent":{"description":"An X.509v3 certificate failed to validate, currently this validation is performed on the Wi-FI access point and failure may be due to a mismatch upon server certificate validation. However it may in the future include other validation events of an X.509v3 certificate.","properties":{"failureReason":{"description":"The reason why certification validation failed.","type":"string"}},"type":"object"},"ChoosePrivateKeyRule":{"description":"Controls apps' access to private keys. The rule determines which private key, if any, Android Device Policy grants to the specified app. Access is granted either when the app calls KeyChain.choosePrivateKeyAlias (https://de