POST api/Export/ContentKeys

Exports requested content keys.

Request Information

URI Parameters

None.

Body Parameters

Data to use for the export.

ContentKeysToExport
NameDescriptionTypeAdditional information
Ids

The collection of IDs of content keys that must be exported.

Collection of globally unique identifier

Required

Certificate

The X.509 certificate (in the DER or the PFX format) of the receiver of content keys that must be exported.

Collection of byte

Required

CpixVersion

The version of the CPIX document to use for exporting content keys. The default is "1". Supported values are "1" and "2".

string

None.

KeySeedId

Specifies whether a key seed should be used for generating the requested content keys rather than exporting them from the database. Mutually exclusive with specifying the use of the default key seed.

globally unique identifier

None.

UseDefaultKeySeed

Indicates whether the requested keys should be generated using the default key seed instead of exporting them from the database. May not be set to "true" when an explicit key seed is specified.

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "Ids": [
    "8dc5b3de-68b7-490b-a7a9-9b7163113b9d",
    "a52f60d5-06b8-4560-961f-e19ab6b3b236"
  ],
  "Certificate": "QEA=",
  "CpixVersion": "sample string 1",
  "KeySeedId": "1b1316a0-4293-4150-99a2-ab3b36869b29",
  "UseDefaultKeySeed": true
}

Response Information

Resource Description

None.

Status Codes

All HTTP status codes must be expected, but the following status codes are the most probable:

  • OK (200) - Content keys are successfully exported.
  • BadRequest (400) - Provided data is invalid.

Response Formats

application/cpix+xml

Sample:
<?xml version="1.0" encoding="utf-8"?>
<cpix:CPIX xmlns:xenc="http://www.w3.org/2001/04/xmlenc#" xmlns:ds="http://www.w3.org/2000/09/xmldsig#" xmlns:cpix="urn:dashif:org:cpix">
  <cpix:DeliveryData>
    <cpix:DeliveryKey>
      <ds:X509Data>
        <ds:X509Certificate>MIIEizCCAnMCCQC62C7xyTt/SjANBgkqhkiG9w0BAQsFADCBijELMAkGA1UEBhMCRUUxETAPBgNVBAgMCFRhcnR1bWFhMQ4wDAYDVQQHDAVUYXJ0dTEPMA0GA1UECgwGQXhpbm9tMQwwCgYDVQQLDANEUk0xEzARBgNVBAMMCktleSBTZXJ2ZXIxJDAiBgkqhkiG9w0BCQEWFWtleXNlcnZlckBleGFtcGxlLmNvbTAgFw0xNjA0MTgwNzQ3NTRaGA8zMDE1MDgyMDA3NDc1NFowgYExCzAJBgNVBAYTAkVFMREwDwYDVQQIDAhUYXJ0dW1hYTEOMAwGA1UEBwwFVGFydHUxDzANBgNVBAoMBkF4aW5vbTEMMAoGA1UECwwDRFJNMQ4wDAYDVQQDDAVUZXN0czEgMB4GCSqGSIb3DQEJARYRdGVzdHNAZXhhbXBsZS5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCvM0Bui5A2LUW/0VS0Fp36Stk0j6v0KQP+2O58DWBsHz/rfGhgV2zCojU07K4gVoeE3v4SYNCRTHohtQVu8rywD5jNMk/z4QD6If0c01LU/aSIeUvauDuCTrlRgJAiF2mlwbmGlfOimv7YbuzuejUgoYXq9Y1dUY342mnyQZwSZy9NgEuBS4d5D/CCM9xSGJubB5FqzLjJzFBANS7G+yGlsl9YlMFSeCxx25OTiQKeT5GoSxJv+/KP6Ahkmv6StwT1GBysq+8Xc0Y+BPAxUZHhqlM5NQ/Lu49ENcXS6FM+c3hSCwh04tetKwVbFE2PFpDCIBRalnv+Zr/+q3QVQcmpAgMBAAEwDQYJKoZIhvcNAQELBQADggIBAEQ+CQQIYy0EQfLapYv8A0BKA9zWjqLat3rGrUUg84hbDLEw9sk+A4ef+A4A+EotoUFYEihkVYE+g8J9fi9QBrg4dVyxZce8PqppQw4HPXpLXX/4fVtqTWNTflU8qXOEhfG87a4TrCjbs99RV7mpxw3Atkc64LX1fipZJtpNGnJyWEQzTPoYQSJ2S6hgXezlf4RzQEdTfll2pf/BGt2QqnBLpoAnTH1DOlKjpeG7/OmLecHWIKDPueq/BaOhETNbjU8t9nT9G5gOgkF+31z7HyKupXaM6louZvdfD0RWTd9Mkn5epjD4EPWq8boVRKOUVAFbVuNuTQMvpRZlvUR+97oSylihxpDaJDnyv6nipFAVnJMitzaCXO34da7K0Xynhmf7JhXMSnbTjWH4RNEulL+B9HxKG11xNHscXN4mU3ODI9dK14gL837f0ihDwXyBWXLL4e3e8QHbzJQTEHj0M3IYlmRaOHWJ1uTlySWaXj5kschDgK18ApPTK85+nuxFvqbSliUNhFDLOLZEqd2cH2GuE+jAF6YAAQrnaLe58bESsoneLqayKZFAkUmDVYgvOO2gHKpmHU3TtKOsO9tl68b1zaaG2tGb9Yt9Hbt5AdM3nMiB0fd8E8MaP5uPWgspsK/Js6y0neRksJ+PYufL2YW46j4y0DutPZwjBb/0VC0S</ds:X509Certificate>
      </ds:X509Data>
    </cpix:DeliveryKey>
    <cpix:DocumentKey Algorithm="http://www.w3.org/2001/04/xmlenc#aes256-cbc">
      <cpix:Data>
        <cpix:Secret>
          <cpix:EncryptedValue>
            <xenc:EncryptionMethod Algorithm="http://www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1p" />
            <xenc:CipherData>
              <xenc:CipherValue>OvFKGMu71T/3VncmDqC32P3yXLQnmLruclrZjbdrIQWbe3VUPGF0AfdCxldC285OJTBEDxWulSvPgFFBouc47VRNvwpZpoqEzG6wrpPL/Jp3Hl0y9On2J1VSBy1PSAl9XmtzbOarM9g6m6e510NY3lrgdRbqeZveok40j9C9IhHD2T4BZCtbrxaP1xBb5ZH3P9Psne1Yv6Iy41bFEeyPMMa+r1knIk4OVzX8r+IlW9NIiNkFtwgT761DTOa37e2O89usRdG5qe96vVAYYMuRAHpNEk6QkRaj6XOSoWNoHgZ6nFpQ7MtbjuropnrpyZvgphfHjy4qi6SgCkKEZ5yjLw==</xenc:CipherValue>
            </xenc:CipherData>
          </cpix:EncryptedValue>
        </cpix:Secret>
      </cpix:Data>
    </cpix:DocumentKey>
    <cpix:MACKey Algorithm="http://www.w3.org/2001/04/xmldsig-more#hmac-sha512">
      <cpix:Key>
        <xenc:EncryptionMethod Algorithm="http://www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1p" />
        <xenc:CipherData>
          <xenc:CipherValue>IpmVSWKxQ3u01ljuflptBetC8/kvc5tNRnquXm933iGSuj63zDyLR7y6YNxjqU1+GkAIoH4E+qTkORw2pQZAXndOTaF/7zLSBmbORyUd3GESBDeCXQm9tEcdAP9tZ+6a5ACJ/b6MQ4gPVekZGBkPaUCWhUIQE1xASBqMJpgF/CwaRzZyCGd/aAg3IN5OaHTa+xuFT3RbRanGg6FbkKj4CQ4kX3KXl+0Rli5IFuky8LiLsnOvBLGGkdksV+az8qytcZcMZnGuCmLWVoTYm3JIJZ98wDaEgOeIKnyqPVsW7t+UaFEsjOCSZihya7QrrlJXqjHK3AbHcgsVngIvFrCGew==</xenc:CipherValue>
        </xenc:CipherData>
      </cpix:Key>
    </cpix:MACKey>
  </cpix:DeliveryData>
  <cpix:ContentKey keyId="17c0da5d-cf55-4905-aaa6-9b51fe809f39" Algorithm="urn:axinom:contentkey">
    <cpix:Data>
      <cpix:Secret>
        <cpix:EncryptedValue>
          <xenc:EncryptionMethod Algorithm="http://www.w3.org/2001/04/xmlenc#aes256-cbc" />
          <xenc:CipherData>
            <xenc:CipherValue>LrO80vXnVVILbg7nlClACPTdM+4/ZgYymdMAe4KVAL0=</xenc:CipherValue>
          </xenc:CipherData>
        </cpix:EncryptedValue>
        <cpix:ValueMAC>QIrWIKShf/n1cKUn1ij2TgN2z0Ly075A8fzeiTe6wpVH2hWBTN8Mv/OFSsH8E6jjMmn0cf+Y8mElrU5G4bCp4Q==</cpix:ValueMAC>
      </cpix:Secret>
    </cpix:Data>
  </cpix:ContentKey>
  <cpix:ContentKey keyId="8416d12e-c962-4c42-8ed6-887f2a027083" Algorithm="urn:axinom:contentkey">
    <cpix:Data>
      <cpix:Secret>
        <cpix:EncryptedValue>
          <xenc:EncryptionMethod Algorithm="http://www.w3.org/2001/04/xmlenc#aes256-cbc" />
          <xenc:CipherData>
            <xenc:CipherValue>D33Z29fEIRJVmjmPiBsP/rXoxGOylWtNDsrH2jFZb+A=</xenc:CipherValue>
          </xenc:CipherData>
        </cpix:EncryptedValue>
        <cpix:ValueMAC>4Jfzq4oozeW6pxF7lnKGViNXfg6FQdomtef8k7yC31TlYoRxrzvN2+6MgQxuAYfh++Zem6ZFsNoEiIzgtSwt8w==</cpix:ValueMAC>
      </cpix:Secret>
    </cpix:Data>
  </cpix:ContentKey>
  <Signature xmlns="http://www.w3.org/2000/09/xmldsig#">
    <SignedInfo>
      <CanonicalizationMethod Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315" />
      <SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha512" />
      <Reference URI="">
        <Transforms>
          <Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature" />
        </Transforms>
        <DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha512" />
        <DigestValue>EvO9sIGmTjDkfCL1/Jd/4w0zzFUqDT2vY9tVzOMTQYSTsvPnFEn5y95dYKowU6gZudD1rDJHTUIEMcOjskXhuw==</DigestValue>
      </Reference>
    </SignedInfo>
    <SignatureValue>Q16DrGCqvIWY0SW0R5rzlC4mL/Vc+h2myJwGDtg7/zrD/JH2S3M8XYg/ufs4i/31K0Gbafwu/px21jCDRsSGGeIwJL1eVdjjKOaSJPRbLstwcx3PHkqJpBMmUvqries6Ge3S7RxGwrVdV/RCfSBqtFPo1rDwuTxpp7xbgxmKK1D+HZhjQwg6u3HP313MxnF93DoD2gtAI7BnFPKseyUGM+1ZnvAcK6c5zfEoMekKfrhHRaHoxvA5RJukgGKdPig8pybrjFlekWh4wmzUqsDhxH8mfDgMKA/ZYSWgVTttANCx6T6+7h32Ip72El6b7+lqtIMItDgpc3q9/+Y3fLTXSA==</SignatureValue>
    <KeyInfo>
      <X509Data>
        <X509Certificate>MIIEEzCCAvugAwIBAgIJALWhyqvE5bMyMA0GCSqGSIb3DQEBCwUAMIGeMQswCQYDVQQGEwJFRTERMA8GA1UECAwIVGFydHVtYWExDjAMBgNVBAcMBVRhcnR1MQ8wDQYDVQQKDAZBeGlub20xDDAKBgNVBAsMA0RSTTEnMCUGA1UEAwweS2V5IFNlcnZlciBTaWduaW5nIENlcnRpZmljYXRlMSQwIgYJKoZIhvcNAQkBFhVrZXlzZXJ2ZXJAZXhhbXBsZS5jb20wIBcNMTYwNTE4MDc1NjQ1WhgPMzAxNTA5MTkwNzU2NDVaMIGeMQswCQYDVQQGEwJFRTERMA8GA1UECAwIVGFydHVtYWExDjAMBgNVBAcMBVRhcnR1MQ8wDQYDVQQKDAZBeGlub20xDDAKBgNVBAsMA0RSTTEnMCUGA1UEAwweS2V5IFNlcnZlciBTaWduaW5nIENlcnRpZmljYXRlMSQwIgYJKoZIhvcNAQkBFhVrZXlzZXJ2ZXJAZXhhbXBsZS5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCvIRDSKTE4lx1SMtNTlVsNQ0aUvx2ySzhwpojCRc2bj7dRcPJJK4Vxm7VN12TYNL+jnSAJX7VElsDukIF5XcfLe4tq8Kox5x/jYNU/PBotV+yzUTGVAOnTspm6oD+HUtryWbrzy36ljqFuUJQsIxOWVxaU2Wlu32Qkpae+NZFZuVwoDRAyBvav8Hvi7i1RGwJjlhcQ1P9loQta/EiGTbVMhwdI1+t1zSxFwwctAFtmNNdllOIR522hBifk/Tmti6bOo/JqZa157n4/puYTDFb+GEgBa7noJvu3J4GWew01qwxU6T8aBSh6gaBaCwfCz+5t70W87j16erra2VBKJUiPAgMBAAGjUDBOMB0GA1UdDgQWBBQa2PttiSrkLDoWsNgUGZUnEO7jsjAfBgNVHSMEGDAWgBQa2PttiSrkLDoWsNgUGZUnEO7jsjAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBCwUAA4IBAQBraT2yArecfBj37SGH/JohSc7vIMuFTeiMjsLaGy8F1aGP2ChFy51dWs951egwfJJfPhMxct2lsPgLmht2zOf721b4GWis/rjGIIYz3chztrrtGzpHkAeR/ucyIWLkNgv+si9Dm9sGyimT9eOVtRSsUXsB2XBYNysBNcK5+zUJtWpByDHWlCf7NovYUPwSxA1Cyyc8Q2sPBkRpvUjof0ZIUqHMdoz8Gh/zsNxf/JUZdQZ56VEOCx8jGquSihC7ln+pkhJDGy13YokyA+KcqM7Q96zkcN5wRXXytQfHAOy/95n3K7Nw2Kd+s1rsh+QuG2dT0kg6Dy323kvwKTml6YGb</X509Certificate>
      </X509Data>
    </KeyInfo>
  </Signature>
</cpix:CPIX>