Gcp/androiddeviceprovisioning
@swamp/gcp/androiddeviceprovisioningv2026.07.21.4
01README
Google Cloud androiddeviceprovisioning infrastructure models
02Release Notes
- Updated: customers, customers_configurations, customers_devices, customers_dpcs, partners_customers, partners_devices, partners_vendors, partners_vendors_customers
03Models
@swamp/gcp/androiddeviceprovisioning/customersv2026.07.21.2customers.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
fn get(identifier: string)
Get a customers
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the customers |
fn sync(identifier?: string)
Sync customers state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific customers by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List customers resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Required. The maximum number of customers to show in a page of results. A number between 1 and 100 (inclusive). |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A reseller, vendor, or customer in the zero-touch reseller and customer APIs.
@swamp/gcp/androiddeviceprovisioning/customers-configurationsv2026.07.21.3customers_configurations.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| companyName? | string | Required. The name of the organization. Zero-touch enrollment shows this organization name to device users during device provisioning. |
| configurationName? | string | Required. A short name that describes the configuration's purpose. For example, _Sales team_ or _Temporary employees_. The zero-touch enrollment portal displays this name to IT admins. |
| contactEmail? | string | Required. The email address that device users can contact to get help. Zero-touch enrollment shows this email address to device users before device provisioning. The value is validated on input. |
| contactPhone? | string | Required. The telephone number that device users can call, using another device, to get help. Zero-touch enrollment shows this number to device users before device provisioning. Accepts numerals, spaces, the plus sign, hyphens, and parentheses. |
| customMessage? | string | A message, containing one or two sentences, to help device users get help or give them more details about what’s happening to their device. Zero-touch enrollment shows this message before the device is provisioned. |
| dpcExtras? | string | The JSON-formatted EMM provisioning extras that are passed to the DPC. |
| dpcResourcePath? | string | Required. The resource name of the selected DPC (device policy controller) in the format `customers/[CUSTOMER_ID]/dpcs/*`. To list the supported DPCs, call `customers.dpcs.list`. |
| forcedResetTime? | string | Optional. The timeout before forcing factory reset the device if the device doesn't go through provisioning in the setup wizard, usually due to lack of network connectivity during setup wizard. Ranges from 0-6 hours, with 2 hours being the default if unset. |
| isDefault? | boolean | Required. Whether this is the default configuration that zero-touch enrollment applies to any new devices the organization purchases in the future. Only one customer configuration can be the default. Setting this value to `true`, changes the previous default configuration's `isDefault` value to `false`. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a configurations
fn get(identifier: string)
Get a configurations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the configurations |
fn update(identifier?: string)
Update configurations attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific configurations by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the configurations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the configurations |
fn sync(identifier?: string)
Sync configurations state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific configurations by name (e.g. one discovered by list) |
fn list(maxPages?: number)
List configurations resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A configuration collects the provisioning options for Android devices. Each c...
@swamp/gcp/androiddeviceprovisioning/customers-devicesv2026.07.21.3customers_devices.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn get(identifier: string)
Get a devices
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the devices |
fn delete(identifier: string)
Delete the devices
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the devices |
fn sync(identifier?: string)
Sync devices state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific devices by name (e.g. one discovered by list) |
fn list(pageSize?: string, maxPages?: number)
List devices resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | string | Optional. The maximum number of devices to show in a page of results. If unset or 0, defaults to 1000. If a value greater than 1000 is specified, it will be coerced to 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn apply_configuration(configuration?: any, device?: any)
apply configuration
| Argument | Type | Description |
|---|---|---|
| configuration? | any | |
| device? | any |
fn unclaim(device?: any)
unclaim
| Argument | Type | Description |
|---|---|---|
| device? | any |
Resources
state(infinite)— An Android or Chrome OS device registered for zero-touch enrollment.
@swamp/gcp/androiddeviceprovisioning/customers-dpcsv2026.07.21.2customers_dpcs.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn get(identifier: string)
Get a dpcs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the dpcs |
fn sync(identifier?: string)
Sync dpcs state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific dpcs by name (e.g. one discovered by list) |
fn list(maxPages?: number)
List dpcs resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— An EMM's DPC ([device policy controller](http://developer.android.com/work/dp...
@swamp/gcp/androiddeviceprovisioning/partners-customersv2026.07.21.3partners_customers.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| customer? | object | Required. The company data to populate the new customer. Must contain a value for `companyName` and at least one `owner_email` that's associated with a Google Account. The values for `companyId` and `name` must be empty. |
| partnerId | string | Required. The ID of the reseller partner. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create()
Create a customers
fn get(identifier: string)
Get a customers
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the customers |
fn sync(identifier?: string)
Sync customers state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific customers by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List customers resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | The maximum number of results to be returned. If not specified or 0, all the records are returned. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A reseller, vendor, or customer in the zero-touch reseller and customer APIs.
@swamp/gcp/androiddeviceprovisioning/partners-devicesv2026.07.21.2partners_devices.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
fn get(identifier: string)
Get a devices
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the devices |
fn sync(identifier?: string)
Sync devices state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific devices by name (e.g. one discovered by list) |
fn claim(configurationId?: any, customerId?: any, deviceIdentifier?: any, deviceMetadata?: any, googleWorkspaceCustomerId?: any, preProvisioningToken?: any, sectionType?: any, simlockProfileId?: any)
claim
| Argument | Type | Description |
|---|---|---|
| configurationId? | any | |
| customerId? | any | |
| deviceIdentifier? | any | |
| deviceMetadata? | any | |
| googleWorkspaceCustomerId? | any | |
| preProvisioningToken? | any | |
| sectionType? | any | |
| simlockProfileId? | any |
fn claim_async(claims?: any)
claim async
| Argument | Type | Description |
|---|---|---|
| claims? | any |
fn find_by_identifier(deviceIdentifier?: any, limit?: any, pageToken?: any)
find by identifier
| Argument | Type | Description |
|---|---|---|
| deviceIdentifier? | any | |
| limit? | any | |
| pageToken? | any |
fn find_by_owner(customerId?: any, googleWorkspaceCustomerId?: any, limit?: any, pageToken?: any, sectionType?: any)
find by owner
| Argument | Type | Description |
|---|---|---|
| customerId? | any | |
| googleWorkspaceCustomerId? | any | |
| limit? | any | |
| pageToken? | any | |
| sectionType? | any |
fn get_sim_lock_state(deviceIdentifier?: any)
get sim lock state
| Argument | Type | Description |
|---|---|---|
| deviceIdentifier? | any |
fn metadata(deviceMetadata?: any)
metadata
| Argument | Type | Description |
|---|---|---|
| deviceMetadata? | any |
fn unclaim(deviceId?: any, deviceIdentifier?: any, sectionType?: any, vacationModeDays?: any, vacationModeExpireTime?: any)
unclaim
| Argument | Type | Description |
|---|---|---|
| deviceId? | any | |
| deviceIdentifier? | any | |
| sectionType? | any | |
| vacationModeDays? | any | |
| vacationModeExpireTime? | any |
fn unclaim_async(unclaims?: any)
unclaim async
| Argument | Type | Description |
|---|---|---|
| unclaims? | any |
fn update_metadata_async(updates?: any)
update metadata async
| Argument | Type | Description |
|---|---|---|
| updates? | any |
Resources
state(infinite)— An Android or Chrome OS device registered for zero-touch enrollment.
@swamp/gcp/androiddeviceprovisioning/partners-vendorsv2026.07.21.2partners_vendors.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn get(identifier: string)
Get a vendors
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the vendors |
fn sync(identifier?: string)
Sync vendors state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific vendors by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List vendors resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | The maximum number of results to be returned. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A reseller, vendor, or customer in the zero-touch reseller and customer APIs.
@swamp/gcp/androiddeviceprovisioning/partners-vendors-customersv2026.07.21.2partners_vendors_customers.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn get(identifier: string)
Get a customers
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the customers |
fn sync(identifier?: string)
Sync customers state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific customers by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List customers resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | The maximum number of results to be returned. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A reseller, vendor, or customer in the zero-touch reseller and customer APIs.
04Previous Versions
2026.07.21.1
- Updated: customers_configurations, partners_customers
2026.07.20.2
- Updated: customers_devices
2026.07.20.1
- Updated: customers, customers_configurations, customers_devices, customers_dpcs, partners_customers, partners_devices, partners_vendors, partners_vendors_customers
2026.07.19.2
- Updated: partners_customers
2026.07.19.1
- Updated: customers, customers_configurations, customers_devices, customers_dpcs, partners_customers, partners_devices, partners_vendors, partners_vendors_customers
2026.07.18.2
- Updated: customers, customers_configurations, customers_devices, customers_dpcs, partners_customers, partners_devices, partners_vendors, partners_vendors_customers
2026.07.17.2
- Updated: customers_configurations
2026.07.17.1
- Updated: customers_configurations, customers_devices
2026.07.14.1
- Updated: customers_devices
2026.06.08.2
- Updated: customers, customers_configurations, customers_devices, customers_dpcs, partners_customers, partners_devices, partners_vendors, partners_vendors_customers
2026.06.07.1
- Updated: customers, customers_configurations, customers_devices, customers_dpcs, partners_customers, partners_devices, partners_vendors, partners_vendors_customers
2026.05.25.3
- Updated: customers_configurations, customers_dpcs
Modified 7 models
2026.05.24.1
- Updated: customers, customers_configurations, customers_devices, customers_dpcs, partners_customers, partners_devices, partners_vendors, partners_vendors_customers
2026.05.21.2
- Updated: customers, customers_configurations, customers_devices, customers_dpcs, partners_customers, partners_devices, partners_vendors, partners_vendors_customers
2026.05.21.1
2026.05.19.2
2026.05.19.1
2026.04.23.1
2026.04.03.3
- Updated: customers, customers_configurations, customers_devices, customers_dpcs, partners_customers, partners_devices, partners_vendors, partners_vendors_customers
05Stats
A
100 / 100
Downloads
0
Archive size
70.2 KB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
06Platforms
07Labels