Method: keyboxcohorts.streamCreateKeyboxCohort

keyboxcohorts.streamCreateKeyboxCohort creates a KeyboxCohort and a collection of Keyboxes from a stream of device IDs.

To create a KeyboxCohort, the client streams StreamCreateKeyboxCohortRequest messages to the server, each of which contains multiple deviceIds. Each message in the stream must not exceed the message size limitation enforced by the server which is 1M bytes. It is an error for messages in the stream to have different values for the 'deviceName' or 'type' fields."

The service returns a google.longrunning.Operation that can be used to retrieve the status of the Keybox generation. For more information, see Operations at

HTTP request


The URL uses gRPC Transcoding syntax.

Request body

The request body contains data with the following structure:

JSON representation
  "deviceName": string,
  "type": enum (KeyboxType),
  "deviceIds": [
  "creatorCompanyId": string


Device name. For example, "shamu" is the device name for Nexus 6.


enum (KeyboxType)

The type of Keybox that will make up the KeyboxCohort.



The list of device ids for which to create Keyboxes.


string (int64 format)

Creator company ID.

Response body

If successful, the response body contains an instance of Operation.

Authorization Scopes

Requires the following OAuth scope:


For more information, see the OAuth 2.0 Overview.