Favicon

You are here: Home > API Reference > AOSP > Android Non Gms Enrollment Tokens > List non-GMS Android enrollment tokens

GET /organizations/:organizationId/mdm/aosp/enterprise/enrollment-tokens

Required Permission: mdm.aosp.enrollmentToken.list

Retrieve non-GMS Android enrollment tokens for the enterprise

GET
/v1/organizations/:organizationId/mdm/aosp/enterprise/enrollment-tokens
Copy to clipboard

List non-GMS Android enrollment tokens

Required Permission: mdm.aosp.enrollmentToken.list

Retrieve non-GMS Android enrollment tokens for the enterprise

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,}))$
page integer
optional
Page number for paginated enrollment token results.
limit integer
optional
Maximum number of enrollment tokens to return per page.
sort string
optional
Sort expression applied to the enrollment token list.
Match pattern: ^[\w.]*((:asc)|(:desc))?$
status any
optional
Filter tokens by one or more token states.
segmentId integer
optional
Optional segment identifier used to scope the resource within the organization.
expandTo string
optional
Segment expansion mode applied when filtering by segment.
childrenancestors

Responses

200 Response application/json
status boolean required
data object required
items array [object] required
id string required
Identifier of the AOSP enrollment token resource.
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}$
segmentId integer optional
Optional segment identifier used to scope the resource within the organization.
≥ 0 · ≤ 9007199254740991
mdmUserId string required
Identifier of the MDM user associated with the enrollment token.
Match pattern: ^[a-fA-F0-9]{24}$
mdmUser object optional
Optional expanded MDM user metadata.
type string required
Top-level MDM resource type.
aosp
subType string required
Subtype of the AOSP resource returned by this endpoint.
enrollment
status string required
Current backend status of the enrollment token.
PENDING PROCESSING DONE DELETED EXPIRED
state string required
Current state mirror kept for compatibility with other MDM resources.
PENDING PROCESSING DONE DELETED EXPIRED
summary object required
Operational summary of the token lifecycle.
managementMode string required
Provisioning mode requested for devices enrolled with this token.
DEVICE_OWNER MANAGEMENT_MODE_UNSPECIFIED
perpetual boolean required
Whether the token can be reused without expiring after a single successful enrollment.
aosDeviceId string optional
Identifier of the enrolled AOSP device when the token has already been consumed.
Match pattern: ^[a-fA-F0-9]{24}$
aosPolicyAssignments array [object] optional
Ordered AOSP policy assignments that will apply to enrolled devices.
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.
dpcBuildTag string optional
Optional DPC build tag used to select a specific AOSP agent build for onboarding.
≤ 256 characters
pushNotificationProvider string optional
Optional push notification provider override used for this enterprise or resource.
Match pattern: ^[a-fA-F0-9]{24}$
config object optional
Resolved bootstrap configuration generated for the enrollment token.
updatedAt string required
Timestamp when the resource was last updated.
createdAt string required
Timestamp when the resource was created.
totalDocs integer required
≥ -9007199254740991 · ≤ 9007199254740991
limit integer required
≥ -9007199254740991 · ≤ 9007199254740991
hasPrevPage boolean required
hasNextPage boolean required
page integer required
≥ -9007199254740991 · ≤ 9007199254740991
totalPages integer required
≥ -9007199254740991 · ≤ 9007199254740991
prevPage integer required
≥ -9007199254740991 · ≤ 9007199254740991
nextPage integer required
≥ -9007199254740991 · ≤ 9007199254740991
{
    "status": true,
    "data": {
        "items": [
            {
                "id": "string",
                "organizationId": "string",
                "aosEnterpriseId": "string",
                "segmentId": 0,
                "mdmUserId": "string",
                "mdmUser": {
                    "id": "string",
                    "email": "string"
                },
                "type": "aosp",
                "subType": "enrollment",
                "status": "PENDING",
                "state": "PENDING",
                "summary": {
                    "managementMode": "DEVICE_OWNER",
                    "expirationTimestamp": "string"
                },
                "managementMode": "DEVICE_OWNER",
                "perpetual": true,
                "aosDeviceId": "string",
                "aosPolicyAssignments": [
                    {
                        "aosPolicyId": "string",
                        "aosPolicy": {
                            "id": "string",
                            "name": "string",
                            "version": "string"
                        },
                        "priority": 0
                    }
                ],
                "displayName": "string",
                "tags": [
                    "string"
                ],
                "dpcBuildTag": "string",
                "pushNotificationProvider": "string",
                "config": {
                    "oneTimeToken": "string",
                    "enrollmentHost": "string",
                    "qrCode": {}
                },
                "updatedAt": "string",
                "createdAt": "string"
            }
        ],
        "totalDocs": 0,
        "limit": 0,
        "hasPrevPage": true,
        "hasNextPage": true,
        "page": 0,
        "totalPages": 0,
        "prevPage": 0,
        "nextPage": 0
    }
}
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"
    }
}