Favicon

You are here: Home > API Reference > AOSP > Android Non Gms Devices > Update non-GMS Android device

PUT /organizations/:organizationId/mdm/aosp/enterprise/devices/:aosDeviceId

Required Permission: mdm.aosp.device.update

Update metadata and assignments for a non-GMS Android device and return the lean list response shape.

PUT
/v1/organizations/:organizationId/mdm/aosp/enterprise/devices/:aosDeviceId
Copy to clipboard

Update non-GMS Android device

Required Permission: mdm.aosp.device.update

Update metadata and assignments for a non-GMS Android device and return the lean list response shape.

Request

Add parameter in header authorization
Example: Authorization: Bearer <token>
organizationId string
required
Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$
aosDeviceId string
required
Match pattern: ^[a-fA-F0-9]{24}$
Body Params application/json
displayName string optional
Optional human-friendly label shown in the dashboard.
≤ 256 characters
tags array optional
Free-form labels used to group and filter AOSP resources in the dashboard.
policyId string optional
Optional directly assigned AOSP policy identifier for the device.
Match pattern: ^[a-fA-F0-9]{24}$
aosPolicyAssignments array [object] optional
Optional ordered AOSP policy assignments used to compose the effective policy.
aosPolicyId string required
Match pattern: ^[a-fA-F0-9]{24}$
priority integer required
≥ -9007199254740991 · ≤ 9007199254740991
mdmUserId string optional
Optional MDM user identifier to associate with the device. Send null to remove the current association.
Match pattern: ^[a-fA-F0-9]{24}$
pushNotificationProvider string optional
Optional push notification provider override used for this enterprise or resource.
Match pattern: ^[a-fA-F0-9]{24}$
segmentId integer optional
Optional segment identifier used to scope the resource within the organization.
≥ 0 · ≤ 9007199254740991
{
    "displayName": "string",
    "tags": [
        "string"
    ],
    "policyId": "string",
    "aosPolicyAssignments": [
        {
            "aosPolicyId": "string",
            "priority": 0
        }
    ],
    "mdmUserId": "string",
    "pushNotificationProvider": "string",
    "segmentId": 0
}

Responses

200 Response application/json
status boolean required
data object required
id string required
Identifier of the AOSP device.
Match pattern: ^[a-fA-F0-9]{24}$
organizationId string required
Identifier of the organization that owns the AOSP enterprise resource.
Match pattern: ^[a-fA-F0-9]{24}$
aosEnterpriseId string required
Identifier of the AOSP enterprise configuration associated with this resource.
Match pattern: ^[a-fA-F0-9]{24}$
pushNotificationProvider string optional
Optional push notification provider override used for this enterprise or resource.
Match pattern: ^[a-fA-F0-9]{24}$
segmentId integer optional
Optional segment identifier used to scope the resource within the organization.
≥ 0 · ≤ 9007199254740991
displayName string optional
Optional human-friendly label shown in the dashboard.
≤ 256 characters
tags array required
Free-form labels used to group and filter AOSP resources in the dashboard.
state string required
Current backend-managed lifecycle state of the device.
PROVISIONING ACTIVE DISABLED PENDING_DISENROLL DELETED
type string required
Top-level MDM device type for this resource.
aosp
subType string required
Subtype of the AOSP resource returned by this endpoint.
device
mdmUser object optional
Optional dashboard user metadata associated with the device.
id string optional
Match pattern: ^[a-fA-F0-9]{24}$
email string optional
≤ 128 characters
aosPolicyId string optional
Identifier of the directly assigned AOSP policy, when present.
Match pattern: ^[a-fA-F0-9]{24}$
aosPolicy object optional
Summary of the effective directly assigned AOSP policy.
id string required
Match pattern: ^[a-fA-F0-9]{24}$
name string required
≤ 256 characters
version string required
≤ 128 characters
deviceAosPolicy object optional
Expanded effective device policy returned for the device detail view.
id string required
Identifier of the AOSP policy.
Match pattern: ^[a-fA-F0-9]{24}$
organizationId string required
Identifier of the organization that owns the AOSP enterprise resource.
Match pattern: ^[a-fA-F0-9]{24}$
aosEnterpriseId string required
Identifier of the AOSP enterprise configuration associated with this resource.
Match pattern: ^[a-fA-F0-9]{24}$
name string required
Display name of the AOSP policy.
≤ 256 characters
description string optional
Optional human-readable description of the policy.
≤ 500 characters
config any optional
Raw AOSP policy configuration payload stored by the backend.
private boolean optional
Whether the policy is private to a segment or workflow and should not be broadly reused.
segmentId integer optional
Optional segment identifier used to scope the resource within the organization.
≥ 0 · ≤ 9007199254740991
exposeToChildren any optional
Whether this policy can be inherited by child segments when segment filtering is expanded.
agentConfiguration object optional
Optional policy-level AOSP agent configuration delivered to devices.
assets array [object] optional
Referenced MDM assets attached to the policy.
assetsInfo array [object] optional
Expanded asset metadata returned for dashboard rendering.
applications array [object] required
AOSP application assignments attached to the policy.
applicationsInfo array [object] required
Expanded AOSP application mapping records resolved for dashboard rendering.
certificateProviderIds array [string] optional
Identifiers of certificate providers referenced by the policy.
version integer optional
Internal resource version used by the backend for tracking changes over time.
≥ 0 · ≤ 9007199254740991
updatedAt string required
Timestamp when the resource was last updated.
createdAt string required
Timestamp when the resource was created.
aosPolicyAssignments array [object] required
Ordered AOSP policy assignments used to compose the effective device policy.
aosPolicyId string required
Identifier of the assigned policy.
Match pattern: ^[a-fA-F0-9]{24}$
aosPolicy object required
priority integer required
Policy assignment priority used during composition.
≥ -9007199254740991 · ≤ 9007199254740991
devicePolicyStatus object optional
Comparison between the effective policy and the last reported device state.
pushed boolean required
audit object required
config object optional
Last known AOSP device configuration and reports recorded by the backend.
deviceReport object optional
managementMode string optional
MANAGEMENT_MODE_UNSPECIFIED DEVICE_OWNER
location object optional
appliedPolicy object optional
summary object optional
Latest backend summary captured from device reports and inventory processing.
stateHistory array [object] optional
Historical record of state transitions recorded by the backend.
state string required
PROVISIONING ACTIVE DISABLED PENDING_DISENROLL DELETED
date string required
config object optional
lastStatusReportTime string optional
Timestamp of the most recent status report received from the device.
enrolledDate string required
Timestamp when the device was enrolled, or resource creation time when unavailable.
updatedAt string required
Timestamp when the resource was last updated.
createdAt string required
Timestamp when the resource was created.
{
    "status": true,
    "data": {
        "id": "string",
        "organizationId": "string",
        "aosEnterpriseId": "string",
        "pushNotificationProvider": "string",
        "segmentId": 0,
        "displayName": "string",
        "tags": [
            "string"
        ],
        "state": "PROVISIONING",
        "type": "aosp",
        "subType": "device",
        "mdmUser": {
            "id": "string",
            "email": "string"
        },
        "aosPolicyId": "string",
        "aosPolicy": {
            "id": "string",
            "name": "string",
            "version": "string"
        },
        "deviceAosPolicy": {
            "id": "string",
            "organizationId": "string",
            "aosEnterpriseId": "string",
            "name": "string",
            "description": "string",
            "config": "string",
            "private": true,
            "segmentId": 0,
            "exposeToChildren": true,
            "agentConfiguration": {
                "allowLocation": true,
                "allowPackageTime": true,
                "allowPackageTransfer": true,
                "allowNetworkStatus": true,
                "policyFeatures": {
                    "defaultViewFeature": "bookmarks",
                    "toggledFeatures": [
                        {
                            "name": "bookmarks",
                            "active": true
                        }
                    ],
                    "enableDefaultView": true
                }
            },
            "assets": [
                {
                    "mdmAssetId": "string",
                    "location": "string",
                    "assetName": "string",
                    "scope": "user"
                }
            ],
            "assetsInfo": [
                {}
            ],
            "applications": [
                {
                    "aosApplicationId": "string",
                    "configuration": "string",
                    "action": "forceInstall",
                    "updatePolicy": {},
                    "customAppConfig": {}
                }
            ],
            "applicationsInfo": [
                {
                    "id": "string",
                    "organizationId": "string",
                    "aosEnterpriseId": "string",
                    "type": "build",
                    "config": {
                        "buildId": "string",
                        "applicationId": "string",
                        "filter": "string"
                    },
                    "info": {
                        "id": "string",
                        "bundleId": "string",
                        "name": "string",
                        "icon": "string",
                        "processedVersionName": "string",
                        "versionCode": "string",
                        "size": "string",
                        "originalExtension": "string",
                        "applicationInfo": {
                            "id": "string",
                            "slug": "string",
                            "name": "string",
                            "picture": "string"
                        },
                        "disabled": true,
                        "signatures": {
                            "sha1": "string",
                            "sha256": "string"
                        }
                    },
                    "version": 0,
                    "updatedAt": "string",
                    "createdAt": "string"
                }
            ],
            "certificateProviderIds": [
                "string"
            ],
            "version": 0,
            "updatedAt": "string",
            "createdAt": "string"
        },
        "aosPolicyAssignments": [
            {
                "aosPolicyId": "string",
                "aosPolicy": {
                    "id": "string",
                    "name": "string",
                    "version": "string"
                },
                "priority": 0
            }
        ],
        "devicePolicyStatus": {
            "pushed": true,
            "audit": {
                "name": "string",
                "config": {
                    "version": "string"
                },
                "device": {
                    "version": "string"
                }
            }
        },
        "config": {
            "deviceReport": {
                "name": "string",
                "userName": "string",
                "managementMode": "string",
                "state": "string",
                "appliedState": "string",
                "policyCompliant": true,
                "nonComplianceDetails": [
                    {}
                ],
                "enrollmentTime": "string",
                "lastStatusReportTime": "string",
                "lastPolicyComplianceReportTime": "string",
                "lastPolicySyncTime": "string",
                "policyName": "string",
                "appliedPolicyName": "string",
                "appliedPolicyVersion": "string",
                "apiLevel": 0,
                "enrollmentTokenData": "string",
                "enrollmentTokenName": "string",
                "disabledReason": {},
                "softwareInfo": {
                    "androidVersion": "string",
                    "androidDevicePolicyVersionCode": 0,
                    "androidDevicePolicyVersionName": "string",
                    "androidBuildNumber": "string",
                    "deviceKernelVersion": "string",
                    "bootloaderVersion": "string",
                    "androidBuildTime": "string",
                    "securityPatchLevel": "string",
                    "primaryLanguageCode": "string",
                    "deviceBuildSignature": "string",
                    "systemUpdateInfo": {}
                },
                "hardwareInfo": {
                    "brand": "string",
                    "hardware": "string",
                    "deviceBasebandVersion": "string",
                    "manufacturer": "string",
                    "serialNumber": "string",
                    "model": "string",
                    "batteryShutdownTemperatures": [
                        0
                    ],
                    "batteryThrottlingTemperatures": [
                        0
                    ],
                    "cpuShutdownTemperatures": [
                        0
                    ],
                    "cpuThrottlingTemperatures": [
                        0
                    ],
                    "gpuShutdownTemperatures": [
                        0
                    ],
                    "gpuThrottlingTemperatures": [
                        0
                    ],
                    "skinShutdownTemperatures": [
                        0
                    ],
                    "skinThrottlingTemperatures": [
                        0
                    ],
                    "enterpriseSpecificId": "string",
                    "euiccChipInfo": [
                        {}
                    ]
                },
                "displays": [
                    {}
                ],
                "previousDeviceNames": [
                    "string"
                ],
                "networkInfo": {
                    "imei": "string",
                    "meid": "string",
                    "wifiMacAddress": "string",
                    "networkOperatorName": "string",
                    "telephonyInfos": [
                        {}
                    ]
                },
                "memoryInfo": {},
                "memoryEvents": [
                    {}
                ],
                "powerManagementEvents": [
                    {}
                ],
                "hardwareStatusSamples": [
                    {}
                ],
                "deviceSettings": {},
                "user": {},
                "systemProperties": {},
                "securityPosture": {},
                "ownership": "string",
                "commonCriteriaModeInfo": {},
                "appliedPasswordPolicies": [
                    {}
                ],
                "dpcMigrationInfo": {},
                "defaultApplicationInfo": [
                    {}
                ]
            },
            "managementMode": "MANAGEMENT_MODE_UNSPECIFIED",
            "location": {
                "latitude": 0,
                "longitude": 0,
                "accuracy": 0
            },
            "appliedPolicy": {
                "policyId": "string",
                "status": "success",
                "appliedAt": "string",
                "errorMessage": "string"
            }
        },
        "summary": {},
        "stateHistory": [
            {
                "state": "PROVISIONING",
                "date": "string",
                "config": {}
            }
        ],
        "lastStatusReportTime": "string",
        "enrolledDate": "string",
        "updatedAt": "string",
        "createdAt": "string"
    }
}
401 Response application/json
status boolean optional
false
error object optional
code number optional
4004
message string optional
Invalid Token
{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}
404 Response application/json
status boolean optional
false
error object optional
code number optional
3001
message string optional
Entity not found
{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}