REST Resource: enterprises.webTokens
Stay organized with collections
Save and categorize content based on your preferences.
Resource: WebToken
A web token used to access the managed Google Play iframe.
| JSON representation |
{
"name": string,
"value": string,
"permissions": [
enum (WebTokenPermission)
],
"parentFrameUrl": string,
"enabledFeatures": [
enum (IframeFeature)
]
} |
| Fields |
name |
string
The name of the web token, which is generated by the server during creation in the form enterprises/{enterpriseId}/webTokens/{webTokenId}.
|
value |
string
The token value which is used in the hosting page to generate the iframe with the embedded UI. This is a read-only field generated by the server.
|
permissions[]
(deprecated) |
enum (WebTokenPermission)
Permissions available to an admin in the embedded UI. An admin must have all of these permissions in order to view the UI. This field is deprecated.
|
parentFrameUrl |
string
The URL of the parent frame hosting the iframe with the embedded UI. To prevent XSS, the iframe may not be hosted at other URLs. The URL must use the https scheme.
|
enabledFeatures[] |
enum (IframeFeature)
The features to enable. Use this if you want to control exactly which feature(s) will be activated; leave empty to allow all features. Restrictions / things to note: - If no features are listed here, all features are enabled — this is the default behavior where you give access to all features to your admins.
- This must not contain any
FEATURE_UNSPECIFIED values. - Repeated values are ignored
|
WebTokenPermission
Permissions available to an admin in the managed Google Play iframe.
| Enums |
WEB_TOKEN_PERMISSION_UNSPECIFIED |
This value is ignored. |
APPROVE_APPS |
The permission to approve apps for the enterprise. |
IframeFeature
The feature available via an iframe that this WebToken will give access to.
Methods |
|
|
Creates a web token to access an embeddable managed Google Play web UI for a given enterprise. |
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-02-19 UTC.
[null,null,["Last updated 2025-02-19 UTC."],[[["\u003cp\u003eA WebToken is used to access the managed Google Play iframe and allows admins to perform tasks within the embedded UI, such as approving apps or managing configurations.\u003c/p\u003e\n"],["\u003cp\u003eThe WebToken includes fields such as the token value, permissions, and enabled features which determine the functionalities available to the admin.\u003c/p\u003e\n"],["\u003cp\u003eYou can specify the parent frame URL where the iframe will be hosted and the specific features that should be enabled within the iframe for the admin.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003epermissions\u003c/code\u003e field in \u003ccode\u003eWebToken\u003c/code\u003e is deprecated and the \u003ccode\u003eenabledFeatures\u003c/code\u003e field should be used to control functionalities instead.\u003c/p\u003e\n"]]],["A web token is used to access the managed Google Play iframe, with a server-generated `name` and `value`. The `parentFrameUrl` specifies the hosting URL, using HTTPS. The `enabledFeatures` field determines iframe functionality, such as `PLAY_SEARCH`, `PRIVATE_APPS`, or `STORE_BUILDER`. The deprecated `permissions` field controlled admin access to UI elements like app approvals. `WebTokenPermission` defines permissions like `APPROVE_APPS`, while `IframeFeature` lists available features. A web token can be created for a given enterprise using the `create` method.\n"],null,["# REST Resource: enterprises.webTokens\n\n- [Resource: WebToken](#WebToken)\n - [JSON representation](#WebToken.SCHEMA_REPRESENTATION)\n- [WebTokenPermission](#WebTokenPermission)\n- [IframeFeature](#IframeFeature)\n- [Methods](#METHODS_SUMMARY)\n\nResource: WebToken\n------------------\n\nA web token used to access the managed Google Play iframe.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"value\": string, \"permissions\": [ enum (/android/management/reference/rest/v1/enterprises.webTokens#WebTokenPermission) ], \"parentFrameUrl\": string, \"enabledFeatures\": [ enum (/android/management/reference/rest/v1/enterprises.webTokens#IframeFeature) ] } ``` |\n\n| Fields ||\n|----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` The name of the web token, which is generated by the server during creation in the form `enterprises/{enterpriseId}/webTokens/{webTokenId}`. |\n| `value` | `string` The token value which is used in the hosting page to generate the iframe with the embedded UI. This is a read-only field generated by the server. |\n| `permissions[]` **(deprecated)** | `enum (`[WebTokenPermission](/android/management/reference/rest/v1/enterprises.webTokens#WebTokenPermission)`)` | This item is deprecated! Permissions available to an admin in the embedded UI. An admin must have all of these permissions in order to view the UI. This field is deprecated. |\n| `parentFrameUrl` | `string` The URL of the parent frame hosting the iframe with the embedded UI. To prevent XSS, the iframe may not be hosted at other URLs. The URL must use the https scheme. |\n| `enabledFeatures[]` | `enum (`[IframeFeature](/android/management/reference/rest/v1/enterprises.webTokens#IframeFeature)`)` The features to enable. Use this if you want to control exactly which feature(s) will be activated; leave empty to allow all features. Restrictions / things to note: - If no features are listed here, all features are enabled --- this is the default behavior where you give access to all features to your admins. - This must not contain any `FEATURE_UNSPECIFIED` values. - Repeated values are ignored \u003cbr /\u003e |\n\nWebTokenPermission\n------------------\n\nPermissions available to an admin in the managed Google Play iframe.\n\n| Enums ||\n|------------------------------------|----------------------------------------------------|\n| `WEB_TOKEN_PERMISSION_UNSPECIFIED` | This value is ignored. |\n| `APPROVE_APPS` | The permission to approve apps for the enterprise. |\n\nIframeFeature\n-------------\n\nThe feature available via an iframe that this WebToken will give access to.\n\n| Enums ||\n|----------------------------------|--------------------------------------------------------------------------------------------------------------------|\n| `FEATURE_UNSPECIFIED` | Unspecified feature. |\n| `PLAY_SEARCH` | The [Managed Play search apps page](https://developers.google.com/android/management/apps#search-apps). |\n| `PRIVATE_APPS` | The [private apps page](https://developers.google.com/android/management/apps#private-apps). |\n| `WEB_APPS` | The [Web Apps page](https://developers.google.com/android/management/apps#web-apps). |\n| `STORE_BUILDER` | The [organize apps page](https://developers.google.com/android/management/apps#organize-apps). |\n| `MANAGED_CONFIGURATIONS` | The [managed configurations page](https://developers.google.com/android/management/managed-configurations-iframe). |\n| `ZERO_TOUCH_CUSTOMER_MANAGEMENT` | The [zero-touch iframe](https://developers.google.com/android/management/zero-touch-iframe). |\n\n| Methods ------- ||\n|----------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|\n| ### [create](/android/management/reference/rest/v1/enterprises.webTokens/create) | Creates a web token to access an embeddable managed Google Play web UI for a given enterprise. |"]]
