Method: keyboxcohorts.keyboxes.list

List the Keyboxes for a given KeyboxCohort.

HTTP request

GET https://androidpartner.googleapis.com/v1/{parent=keyboxcohorts/*}/keyboxes

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Parent name.

Query parameters

Parameters
deviceName

string

Device name. For example, "shamu" is the device name for Nexus 6. It is an error if the value of deviceName does not match the deviceName of the parent KeyboxCohort.

pageSize

number

Size of each page.

pageToken

string

The nextPageToken value returned from a previous List request, if any.

creatorCompanyId

string (int64 format)

Creator company ID.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

A request to list Keyboxes.

JSON representation
{
  "keyboxes": [
    {
      object (Keybox)
    }
  ],
  "nextPageToken": string
}
Fields
keyboxes[]

object (Keybox)

A list of Keybox.

nextPageToken

string

Token to retrieve the next page of results, or empty if there are no more results in the list.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/androidPartner

For more information, see the OAuth 2.0 Overview.

Keybox

A Keybox containing data and information to decrypt DRM protected contents.

JSON representation
{

  // Union field keybox can be only one of the following:
  "widevineKeybox": {
    object (WidevineKeybox)
  },
  "androidAttestationKeybox": {
    object (AndroidAttestationKeybox)
  }
  // End of list of possible types for union field keybox.
}
Fields
Union field keybox. Keybox is one of Widevine or Android Attestation. keybox can be only one of the following:
widevineKeybox

object (WidevineKeybox)

Widevine DRM Keybox.

androidAttestationKeybox

object (AndroidAttestationKeybox)

Android Attestation Keybox.

WidevineKeybox

A Widevine Keybox for a single device.

JSON representation
{
  "deviceId": string,
  "key": string,
  "id": string,
  "magic": string,
  "crc": string
}
Fields
deviceId

string

The ID of the device which can use this Keybox.

key

string

Widevine key value.

id

string

Widevine key id.

magic

string

Widevine key magic value.

crc

string

Widevine key crc value.

AndroidAttestationKeybox

Android Attestation Keybox.

JSON representation
{
  "deviceId": string,
  "keys": [
    {
      object (AndroidAttestationKey)
    }
  ]
}
Fields
deviceId

string

The ID of the device which can use this Keybox.

keys[]

object (AndroidAttestationKey)

Android Attestation keys.

AndroidAttestationKey

Android Attestation key.

JSON representation
{
  "algorithm": string,
  "privateKey": {
    object (AndroidAttestationPrivateKey)
  },
  "certificateChain": {
    object (AndroidAttestationCertificateChain)
  }
}
Fields
algorithm

string

Android Attestation key algorithm name.

privateKey

object (AndroidAttestationPrivateKey)

Android Attestation private key.

certificateChain

object (AndroidAttestationCertificateChain)

Android Attestation cerfificate chain.

AndroidAttestationPrivateKey

Android Attestation private key.

JSON representation
{
  "format": string,
  "key": string
}
Fields
format

string

Android Attestation private key format, for example: pem.

key

string

Android Attestation private key value.

AndroidAttestationCertificateChain

Android Attestation certificate chain.

JSON representation
{
  "numberOfCertificates": number,
  "certificate": [
    {
      object (AndroidAttestationCertificate)
    }
  ]
}
Fields
numberOfCertificates

number

Number of Android Attestation certificate.

certificate[]

object (AndroidAttestationCertificate)

A list of Android Attestation certificates.

AndroidAttestationCertificate

Android Attestation certificate.

JSON representation
{
  "format": string,
  "key": string
}
Fields
format

string

Android Attestation certificate format, for example: pem.

key

string

Android Attestation certificate value.