AndroidManagement

import { AndroidManagement } from "https://googleapis.deno.dev/v1/androidmanagement:v1.ts";

The Android Management API provides remote enterprise management of Android devices and apps.

class AndroidManagement {

constructor(client?: CredentialsClient, baseUrl?: string);

async enterprisesApplicationsGet(name: string, opts?: EnterprisesApplicationsGetOptions): Promise<Application>;

async enterprisesCreate(req: Enterprise, opts?: EnterprisesCreateOptions): Promise<Enterprise>;

async enterprisesDelete(name: string): Promise<Empty>;

async enterprisesDevicesDelete(name: string, opts?: EnterprisesDevicesDeleteOptions): Promise<Empty>;

async enterprisesDevicesGet(name: string): Promise<Device>;

async enterprisesDevicesIssueCommand(name: string, req: Command): Promise<Operation>;

async enterprisesDevicesList(parent: string, opts?: EnterprisesDevicesListOptions): Promise<ListDevicesResponse>;

async enterprisesDevicesOperationsCancel(name: string): Promise<Empty>;

async enterprisesDevicesOperationsGet(name: string): Promise<Operation>;

async enterprisesDevicesOperationsList(name: string, opts?: EnterprisesDevicesOperationsListOptions): Promise<ListOperationsResponse>;

async enterprisesDevicesPatch(

req: Device,

opts?: EnterprisesDevicesPatchOptions,

): Promise<Device>;

async enterprisesEnrollmentTokensCreate(parent: string, req: EnrollmentToken): Promise<EnrollmentToken>;

async enterprisesEnrollmentTokensDelete(name: string): Promise<Empty>;

async enterprisesEnrollmentTokensGet(name: string): Promise<EnrollmentToken>;

async enterprisesEnrollmentTokensList(parent: string, opts?: EnterprisesEnrollmentTokensListOptions): Promise<ListEnrollmentTokensResponse>;

async enterprisesGet(name: string): Promise<Enterprise>;

async enterprisesList(opts?: EnterprisesListOptions): Promise<ListEnterprisesResponse>;

async enterprisesMigrationTokensCreate(parent: string, req: MigrationToken): Promise<MigrationToken>;

async enterprisesMigrationTokensGet(name: string): Promise<MigrationToken>;

async enterprisesMigrationTokensList(parent: string, opts?: EnterprisesMigrationTokensListOptions): Promise<ListMigrationTokensResponse>;

async enterprisesPatch(

req: Enterprise,

opts?: EnterprisesPatchOptions,

): Promise<Enterprise>;

async enterprisesPoliciesDelete(name: string): Promise<Empty>;

async enterprisesPoliciesGet(name: string): Promise<Policy>;

async enterprisesPoliciesList(parent: string, opts?: EnterprisesPoliciesListOptions): Promise<ListPoliciesResponse>;

async enterprisesPoliciesPatch(

req: Policy,

opts?: EnterprisesPoliciesPatchOptions,

): Promise<Policy>;

async enterprisesWebAppsCreate(parent: string, req: WebApp): Promise<WebApp>;

async enterprisesWebAppsDelete(name: string): Promise<Empty>;

async enterprisesWebAppsGet(name: string): Promise<WebApp>;

async enterprisesWebAppsList(parent: string, opts?: EnterprisesWebAppsListOptions): Promise<ListWebAppsResponse>;

async enterprisesWebAppsPatch(

req: WebApp,

opts?: EnterprisesWebAppsPatchOptions,

): Promise<WebApp>;

async enterprisesWebTokensCreate(parent: string, req: WebToken): Promise<WebToken>;

async provisioningInfoGet(name: string): Promise<ProvisioningInfo>;

async signupUrlsCreate(opts?: SignupUrlsCreateOptions): Promise<SignupUrl>;

}

§Constructors

new AndroidManagement(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

enterprisesApplicationsGet(name: string, opts?: EnterprisesApplicationsGetOptions): Promise<Application>

[src]

Gets info about an application.

@param name

The name of the application in the form enterprises/{enterpriseId}/applications/{package_name}.

enterprisesCreate(req: Enterprise, opts?: EnterprisesCreateOptions): Promise<Enterprise>

[src]

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

enterprisesDelete(name: string): Promise<Empty>

[src]

Permanently deletes an enterprise and all accounts and data associated with it. Warning: this will result in a cascaded deletion of all AM API devices associated with the deleted enterprise. Only available for EMM-managed enterprises.

@param name

The name of the enterprise in the form enterprises/{enterpriseId}.

enterprisesDevicesDelete(name: string, opts?: EnterprisesDevicesDeleteOptions): Promise<Empty>

[src]

Deletes a device. This operation wipes the device. Deleted devices do not show up in enterprises.devices.list calls and a 404 is returned from enterprises.devices.get.

@param name

The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.

enterprisesDevicesGet(name: string): Promise<Device>

[src]

Gets a device. Deleted devices will respond with a 404 error.

@param name

The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.

enterprisesDevicesIssueCommand(name: string, req: Command): Promise<Operation>

[src]

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.

@param name

The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.

enterprisesDevicesList(parent: string, opts?: EnterprisesDevicesListOptions): Promise<ListDevicesResponse>

[src]

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

@param parent

The name of the enterprise in the form enterprises/{enterpriseId}.

enterprisesDevicesOperationsCancel(name: string): Promise<Empty>

[src]

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.

@param name

The name of the operation resource to be cancelled.

enterprisesDevicesOperationsGet(name: string): Promise<Operation>

[src]

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.

@param name

The name of the operation resource.

enterprisesDevicesOperationsList(name: string, opts?: EnterprisesDevicesOperationsListOptions): Promise<ListOperationsResponse>

[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

enterprisesDevicesPatch(name: string, req: Device, opts?: EnterprisesDevicesPatchOptions): Promise<Device>

[src]

Updates a device.

@param name

The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.

enterprisesEnrollmentTokensCreate(parent: string, req: EnrollmentToken): Promise<EnrollmentToken>

[src]

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.

@param parent

The name of the enterprise in the form enterprises/{enterpriseId}.

enterprisesEnrollmentTokensDelete(name: string): Promise<Empty>

[src]

Deletes an enrollment token. This operation invalidates the token, preventing its future use.

@param name

The name of the enrollment token in the form enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId}.

enterprisesEnrollmentTokensGet(name: string): Promise<EnrollmentToken>

[src]

Gets an active, unexpired enrollment token. Only a partial view of EnrollmentToken is returned: all the fields but name and expiration_timestamp are empty. This method is meant to help manage active enrollment tokens lifecycle. For security reasons, it's recommended to delete active enrollment tokens as soon as they're not intended to be used anymore.

@param name

Required. The name of the enrollment token in the form enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId}.

enterprisesEnrollmentTokensList(parent: string, opts?: EnterprisesEnrollmentTokensListOptions): Promise<ListEnrollmentTokensResponse>

[src]

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.

@param parent

Required. The name of the enterprise in the form enterprises/{enterpriseId}.

enterprisesGet(name: string): Promise<Enterprise>

[src]

Gets an enterprise.

@param name

The name of the enterprise in the form enterprises/{enterpriseId}.

enterprisesList(opts?: EnterprisesListOptions): Promise<ListEnterprisesResponse>

[src]

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

enterprisesMigrationTokensCreate(parent: string, req: MigrationToken): Promise<MigrationToken>

[src]

Creates a migration token, to migrate an existing device from being managed by the EMM's Device Policy Controller (DPC) to being managed by the Android Management API. See the guide (https://developers.google.com/android/management/dpc-migration) for more details.

@param parent

Required. The enterprise in which this migration token is created. This must be the same enterprise which already manages the device in the Play EMM API. Format: enterprises/{enterprise}

enterprisesMigrationTokensGet(name: string): Promise<MigrationToken>

[src]

Gets a migration token.

@param name

Required. The name of the migration token to retrieve. Format: enterprises/{enterprise}/migrationTokens/{migration_token}

enterprisesMigrationTokensList(parent: string, opts?: EnterprisesMigrationTokensListOptions): Promise<ListMigrationTokensResponse>

[src]

Lists migration tokens.

@param parent

Required. The enterprise which the migration tokens belong to. Format: enterprises/{enterprise}

enterprisesPatch(name: string, req: Enterprise, opts?: EnterprisesPatchOptions): Promise<Enterprise>

[src]

Updates an enterprise. See also: SigninDetail

@param name

The name of the enterprise in the form enterprises/{enterpriseId}.

enterprisesPoliciesDelete(name: string): Promise<Empty>

[src]

Deletes a policy. This operation is only permitted if no devices are currently referencing the policy.

@param name

The name of the policy in the form enterprises/{enterpriseId}/policies/{policyId}.

enterprisesPoliciesGet(name: string): Promise<Policy>

[src]

Gets a policy.

@param name

The name of the policy in the form enterprises/{enterpriseId}/policies/{policyId}.

enterprisesPoliciesList(parent: string, opts?: EnterprisesPoliciesListOptions): Promise<ListPoliciesResponse>

[src]

Lists policies for a given enterprise.

@param parent

The name of the enterprise in the form enterprises/{enterpriseId}.

enterprisesPoliciesPatch(name: string, req: Policy, opts?: EnterprisesPoliciesPatchOptions): Promise<Policy>

[src]

Updates or creates a policy.

@param name

The name of the policy in the form enterprises/{enterpriseId}/policies/{policyId}.

enterprisesWebAppsCreate(parent: string, req: WebApp): Promise<WebApp>

[src]

Creates a web app.

@param parent

The name of the enterprise in the form enterprises/{enterpriseId}.

enterprisesWebAppsDelete(name: string): Promise<Empty>

[src]

Deletes a web app.

@param name

The name of the web app in the form enterprises/{enterpriseId}/webApps/{packageName}.

enterprisesWebAppsGet(name: string): Promise<WebApp>

[src]

Gets a web app.

@param name

The name of the web app in the form enterprises/{enterpriseId}/webApp/{packageName}.

enterprisesWebAppsList(parent: string, opts?: EnterprisesWebAppsListOptions): Promise<ListWebAppsResponse>

[src]

Lists web apps for a given enterprise.

@param parent

The name of the enterprise in the form enterprises/{enterpriseId}.

enterprisesWebAppsPatch(name: string, req: WebApp, opts?: EnterprisesWebAppsPatchOptions): Promise<WebApp>

[src]

Updates a web app.

@param name

The name of the web app in the form enterprises/{enterpriseId}/webApps/{packageName}.

enterprisesWebTokensCreate(parent: string, req: WebToken): Promise<WebToken>

[src]

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

@param parent

The name of the enterprise in the form enterprises/{enterpriseId}.

provisioningInfoGet(name: string): Promise<ProvisioningInfo>

[src]

Get the device provisioning information by the identifier provided in the sign-in url.

@param name

Required. The identifier that Android Device Policy passes to the 3P sign-in page in the form of provisioningInfo/{provisioning_info}.

signupUrlsCreate(opts?: SignupUrlsCreateOptions): Promise<SignupUrl>

[src]

Creates an enterprise signup URL.