APIHub
Back to Explore

Android Management API

The Android Management API offers REST operations for administrating Android‑Enterprise resources: creating and listing enterprises, enrollment tokens, policies, devices and web apps, as well as issuing device commands and managing related long‑running operations.

Analytics
OAuth
HTTPS
CORS: Unknown
Description enriched
Visit official documentation

Latency

2705ms p95

Uptime

100.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
GET

/v1/enterprises

Lists EMM-managed enterprises. Only BASIC fields are returned.

  • pageSize (query, limit) — The requested page size. The actual page size may be fixed to a min or max value.
  • pageToken (query) — A token identifying a page of results returned by the server.
  • projectId (query) — Required. The Cloud project ID of the EMM managing the enterprises.
  • view (query) — Specifies which Enterprise fields to return. This method only supports BASIC.
POST

/v1/enterprises

Creates an enterprise. This is the last step in the enterprise signup flow. See also: SigninDetail

  • agreementAccepted (query) — 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).
  • enterpriseToken (query) — 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).
  • projectId (query) — The ID of the Google Cloud Platform project which will own the enterprise.
  • signupUrlName (query) — 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).
POST

/v1/signupUrls

Creates an enterprise signup URL.

  • callbackUrl (query) — 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.
  • projectId (query) — The ID of the Google Cloud Platform project which will own the enterprise.
DELETE

/v1/{name}

Deletes a web app.

  • name (path, required) — The name of the web app in the form enterprises/{enterpriseId}/webApps/{packageName}.
  • wipeDataFlags (query) — Optional flags that control the device wiping behavior.
  • wipeReasonMessage (query) — 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.
GET

/v1/{name}

Gets a web app.

  • name (path, required) — The name of the web app in the form enterprises/{enterpriseId}/webApp/{packageName}.
  • filter (query) — The standard list filter.
  • pageSize (query, limit) — The standard list page size.
  • pageToken (query) — The standard list page token.
PATCH

/v1/{name}

Updates a web app.

  • name (path, required) — The name of the web app in the form enterprises/{enterpriseId}/webApps/{packageName}.
  • updateMask (query) — The field mask indicating the fields to update. If not set, all modifiable fields will be modified.
POST

/v1/{name}:cancel

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.

  • name (path, required) — The name of the operation resource to be cancelled.
POST

/v1/{name}:issueCommand

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.

  • name (path, required) — The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.
GET

/v1/{parent}/devices

Lists devices for a given enterprise. Deleted devices are not returned in the response.

  • parent (path, required) — The name of the enterprise in the form enterprises/{enterpriseId}.
  • pageSize (query, limit) — The requested page size. The actual page size may be fixed to a min or max value.
  • pageToken (query) — A token identifying a page of results returned by the server.
GET

/v1/{parent}/enrollmentTokens

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.

  • parent (path, required) — Required. The name of the enterprise in the form enterprises/{enterpriseId}.
  • pageSize (query, limit) — 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.
  • pageToken (query) — A token identifying a page of results returned by the server.
POST

/v1/{parent}/enrollmentTokens

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.

  • parent (path, required) — The name of the enterprise in the form enterprises/{enterpriseId}.
GET

/v1/{parent}/policies

Lists policies for a given enterprise.

  • parent (path, required) — The name of the enterprise in the form enterprises/{enterpriseId}.
  • pageSize (query, limit) — The requested page size. The actual page size may be fixed to a min or max value.
  • pageToken (query) — A token identifying a page of results returned by the server.
GET

/v1/{parent}/webApps

Lists web apps for a given enterprise.

  • parent (path, required) — The name of the enterprise in the form enterprises/{enterpriseId}.
  • pageSize (query, limit) — The requested page size. This is a hint and the actual page size in the response may be different.
  • pageToken (query) — A token identifying a page of results returned by the server.
POST

/v1/{parent}/webApps

Creates a web app.

  • parent (path, required) — The name of the enterprise in the form enterprises/{enterpriseId}.
POST

/v1/{parent}/webTokens

Creates a web token to access an embeddable managed Google Play web UI for a given enterprise.

  • parent (path, required) — The name of the enterprise in the form enterprises/{enterpriseId}.

15 endpoints auto-detected

Authentication

This API requires authentication: OAuth.

curl -X GET \
  "https://androidmanagement.googleapis.com/v1/enterprises"

androidmanagement.googleapis.com · HTTPS only