Batch get enrollment links
Relative path: /v1/mobile-devices:batchGetEnrollmentLinks
Get enrollment links for a batch of mobile devices in device management. The mobile devices must have is mobile flag set to true.
Warning:
A link only works on Android and iOS operating systems.
There is no limit on number of enrollment links issued for one device. All of them can be valid at the same time (within limits of their own expiration) until the device gets enrolled.
The size of the batch is limited to 1000 devices. If this limit is exceeded, INVALID_ARGUMENT (gRPC) | 400 Bad Request (HTTP) is returned.
The operation fails atomically. If any error occurs, it is returned for the whole batch. The devices are processed in an undetermined order.
- If some device is already enrolled, the link is not generated, and the error FAILED_PRECONDITION (gRPC) | 400 Bad Request (HTTP) is returned.
- For a device not marked as mobile in the device management (effectively not an iOS or Android device), the link is not generated, and error FAILED_PRECONDITION (gRPC) | 400 Bad Request (HTTP) is returned.
- For non-existing devices, the error NOT_FOUND (gRPC) | 404 Not Found (HTTP) is returned.
Base URL for Europe, Germany, United States, Canada and Japan regions:
|
https://eu.mobile-device-management.eset.systems |
|
https://de.mobile-device-management.eset.systems |
|
https://us.mobile-device-management.eset.systems |
|
https://ca.mobile-device-management.eset.systems |
|
https://jpn.mobile-device-management.eset.systems |
Request body
Display Schema instead of an Example or vice-versa
Type |
Required |
Example |
Schema |
|---|---|---|---|
application/json |
Yes |
{
"deviceUuids": [
"string"
]
} |
{
"$ref": "v1BatchGetEnrollmentLinksRequest",
"deviceUuids": [
{
"type": "string"
}
]
} |
Responses
Display Schema+Headers instead of an Example or vice-versa
Code |
Description and Example |
Description, Schema and Headers |
|---|---|---|
200 |
Successful response.
{
"enrollmentLinks": {}
}
|
Successful response.
{
"$ref": "v1BatchGetEnrollmentLinksResponse",
"enrollmentLinks": {
"type": "object",
"additionalProperties": {
"$ref": "v1DeviceEnrollmentLink",
"type": "object",
"properties": {
"expireTime": {
"type": "string",
"description": "The time when the enrollment link expires.",
"format": "date-time"
},
"uri": {
"type": "string",
"description": "URI to be used to finalize the enrollment of the device. The hyperlink points to the (mobile) device management backend, where all the data related to the enrollment are stored."
}
},
"description": "The enrollment link serves to finalize the enrollment process on a device. Every link can only be used once. The link can be used in different channels, sent by email, rendered on screen, scanned as a QR code."
},
"description": "The list of enrollment links for devices from the request. Devices are identified by their universally unique identifiers provided in the request. The enrollment link serves to finalize the enrollment process on a device. Every link can only be used once. The link can be used in different channels, sent by email, rendered on screen, scanned as a QR code. Warning: A link only works on Android and iOS operating systems."
}
}
{
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|
202 |
Response took too long; request cached. Response can be retrieved later using the response-id header. |
Response took too long; request cached. Response can be retrieved later using the response-id header.
[]
{
"response-id": {
"description": "Unique ID of a pending request. Used to retrieve cached result.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
},
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|
400 |
One of the errors: 1. Bad or missing authorization. 2. Validation error. Invalid argument provided. |
One of the errors: 1. Bad or missing authorization. 2. Validation error. Invalid argument provided.
[]
{
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|
401 |
Token has expired or is invalid. |
Token has expired or is invalid.
[]
{
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|
403 |
Access denied. Check permissions. |
Access denied. Check permissions.
[]
{
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|
404 |
Requested resource not found. |
Requested resource not found.
[]
{
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|
429 |
Rate limit reached. Try again later. |
Rate limit reached. Try again later.
[]
{
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|
500 |
Internal server failure. Try again later. |
Internal server failure. Try again later.
[]
{
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|
502 |
Internal server failure. Try again later. |
Internal server failure. Try again later.
[]
{
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|
503 |
Environment under maintenance. Try again later. |
Environment under maintenance. Try again later.
[]
{
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|
504 |
Action took too long; timeout reached |
Action took too long; timeout reached
[]
{
"request-id": {
"description": "Unique ID of the request. Include in support requests.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|