Method: enterprises.enrollmentTokens.get
Stay organized with collections
Save and categorize content based on your preferences.
Gets an active, unexpired enrollment token. A partial view of the enrollment token is returned. Only the following fields are populated: name
, expirationTimestamp
, allowPersonalUsage
, value
, qrCode
. 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.
HTTP request
GET https://androidmanagement.googleapis.com/v1/{name=enterprises/*/enrollmentTokens/*}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
name |
string
Required. The name of the enrollment token in the form enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId} .
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of EnrollmentToken
.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/androidmanagement
For more information, see the OAuth 2.0 Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-09 UTC.
[null,null,["Last updated 2025-01-09 UTC."],[[["\u003cp\u003eRetrieves an active enrollment token with specific fields populated for management purposes.\u003c/p\u003e\n"],["\u003cp\u003eUses a \u003ccode\u003eGET\u003c/code\u003e request with the enrollment token's name specified in the URL path.\u003c/p\u003e\n"],["\u003cp\u003eRequires an empty request body and returns an \u003ccode\u003eEnrollmentToken\u003c/code\u003e object on success.\u003c/p\u003e\n"],["\u003cp\u003eNeeds the \u003ccode\u003ehttps://www.googleapis.com/auth/androidmanagement\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"],["\u003cp\u003eRecommends deleting active enrollment tokens when they are no longer needed for security.\u003c/p\u003e\n"]]],["This describes retrieving an active, unexpired enrollment token via a `GET` HTTP request to a specified URL. The request requires a `name` parameter in the URL, formatted as `enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId}`, and an empty request body. The successful response provides a partial view of the `EnrollmentToken`, including fields like `name`, `expirationTimestamp`, and `value`. It needs OAuth scope `https://www.googleapis.com/auth/androidmanagement` and suggests deleting tokens after use.\n"],null,["# Method: enterprises.enrollmentTokens.get\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nGets an active, unexpired enrollment token. A partial view of the enrollment token is returned. Only the following fields are populated: [`name`](/android/management/reference/rest/v1/enterprises.enrollmentTokens#EnrollmentToken.FIELDS.name), [`expirationTimestamp`](/android/management/reference/rest/v1/enterprises.enrollmentTokens#EnrollmentToken.FIELDS.expiration_timestamp), [`allowPersonalUsage`](/android/management/reference/rest/v1/enterprises.enrollmentTokens#EnrollmentToken.FIELDS.allow_personal_usage), [`value`](/android/management/reference/rest/v1/enterprises.enrollmentTokens#EnrollmentToken.FIELDS.value), [`qrCode`](/android/management/reference/rest/v1/enterprises.enrollmentTokens#EnrollmentToken.FIELDS.qr_code). This method is meant to help manage active enrollment tokens lifecycle. For security reasons, it's recommended to [delete](/android/management/reference/rest/v1/enterprises.enrollmentTokens/delete#google.android.devicemanagement.v1.DeviceManagementService.DeleteEnrollmentToken) active enrollment tokens as soon as they're not intended to be used anymore.\n\n### HTTP request\n\n`GET https://androidmanagement.googleapis.com/v1/{name=enterprises/*/enrollmentTokens/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. The name of the enrollment token in the form `enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId}`. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [EnrollmentToken](/android/management/reference/rest/v1/enterprises.enrollmentTokens#EnrollmentToken).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/androidmanagement`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]