Method: keyboxcohorts.create

Creates a KeyboxCohort which contains a collection of Keyboxes.

To create a KeyboxCohort, the client needs to provide device name, keybox type and a list of device IDs in form of a CSV file. For each device ID, one keybox will be generated.

The service returns a google.longrunning.Operation that can be used to retrieve the status of the Keybox generation.

Please note [keyboxcohorts.create] and [keyboxcohorts.streamCreateKeyboxCohort] both create KeyboxCohort the same way, but they receive device IDs from requests in different formats.

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),
  "deviceIdFilePath": string,
  "creatorCompanyId": string,
  "csr": 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.



This is a file that has been uploaded to Google storage and contains a list of device ids.


string (int64 format)

Creator company ID.



new field for CSR, only valid when KeyboxType is X509_ICA

Response body

If successful, the response body contains a newly created instance of Operation.

Authorization Scopes

Requires the following OAuth scope:


For more information, see the OAuth 2.0 Overview.