REST Resource: enterprises.webTokens

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.

Enums
FEATURE_UNSPECIFIED Unspecified feature.
PRIVATE_APPS The private apps page.
WEB_APPS The Web Apps page.
STORE_BUILDER The organize apps page.
MANAGED_CONFIGURATIONS The managed configurations page.

Methods

create

Creates a web token to access an embeddable managed Google Play web UI for a given enterprise.