Incorrect example for `rewrap_many_data_keys`

ExportXMLWordPrintableJSON

    • None
    • Python Drivers
    • Hide

      1. What would you like to communicate to the user about this feature?
      2. Would you like the user to see examples of the syntax and/or executable code and its output?
      3. Which versions of the driver/connector does this apply to?

      Show
      1. What would you like to communicate to the user about this feature? 2. Would you like the user to see examples of the syntax and/or executable code and its output? 3. Which versions of the driver/connector does this apply to?
    • None
    • None
    • None
    • None
    • None
    • None

      Detailed steps to reproduce the problem?

      The example for rewrap_many_data_keys is incorrect and does not work. If a developer attempts to use the example it fails with an exception.

      Definition of done: what must be done to consider the task complete?

      The example should look something like:

      result = client_encryption.rewrap_many_data_key(
    filter={},
    provider="kmip",
    master_key={
         "keyId": "<your new key name>",
         "endpoint": "<your KMIP endpoint>",
         "delegated": True
    }
)

      or

      client_encryption.rewrap_many_data_key(
    filter={"keyAltNames": "optional filter for which keys you want to update"},
    provider="azure",  # replace with your KMS provider
    master_key={
        # put the rest of your master_key options here
        "keyName": "<your new key name>",
        "keyVaultEndpoint": "<your key vault endpoint>",
    },
)

      or similar.

            Assignee:
            Noah Stapp
            Reporter:
            Brett Gray
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:
              Resolved: