REST Resource: keyboxcohorts

Resource: KeyboxCohort

A KeyboxCohort contains information about a collection of Keyboxes.

JSON representation
{
  "name": string,
  "deviceName": string,
  "type": enum (KeyboxType),
  "numKeys": number,
  "creationTime": string,
  "creatorEmail": string,
  "creatorCompany": string,
  "creationStatus": {
    object (Status)
  },
  "deviceIdFileDownloadUrl": string,
  "keyboxCohortDownloadUrl": string,
  "csrDownloadUrl": string,
  "creatorCompanyId": string
}
Fields
name

string

The name of the resource. This field is generated by the server in response to a keyboxcohorts.streamCreateKeyboxCohort method call.

deviceName

string

The name of the device that the Keyboxes will be installed on. For example, "shamu" is the device name for Nexus 6.

type

enum (KeyboxType)

Each KeyboxCohort contains only one type of Keybox, either Widevine of Android Attestation. The client must specify which Keybox type will be generated.

numKeys

number

The number of keys in the cohort.

creationTime

string (Timestamp format)

KeyboxCohort creation timestamp.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

creatorEmail

string

KeyboxCohort creator email.

creatorCompany

string

KeyboxCohort creator company.

creationStatus

object (Status)

KeyboxCohort creation status.

deviceIdFileDownloadUrl

string

URL to download the set of device IDs used to create this KeyboxCohort.

keyboxCohortDownloadUrl

string

URL to download the list of keyboxes generated as part of this KeyboxCohort.

csrDownloadUrl

string

URL to download the CSR used to create this KeyboxCohort.

creatorCompanyId

string (int64 format)

KeyboxCohort creator company ID. This is a unique ID of the creator company, e.g. if creatorCompany is Google, creatorCompanyId is 1.

KeyboxType

The Keybox type.

Enums
KEYBOX_TYPE_UNSPECIFIED Unspecified type.
WIDEVINE_DRM Widevine DRM Keybox.
ANDROID_ATTESTATION Android Attestation Keybox.
X509_ICA X509 ICA.

Methods

create

Creates a KeyboxCohort which contains a collection of Keyboxes.

get

Gets a KeyboxCohort.

list

Lists KeyboxCohorts.

streamCreateKeyboxCohort

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