UpdateKey Method

Updates a key's information.

Syntax

public func updateKey(keyName: String, keyOps: String, updateTags: Bool) throws -> Void

Remarks

This method updates the information for the key specified by KeyName. The VersionId configuration setting can be used to target a specific key version.

The KeyOps parameter, if non-empty, must be a comma-separated list of operations that the key is valid for. If empty, the key's current operations list remains unchanged. Possible values are as follows; operations should be specified in pairs:

  • encrypt
  • decrypt
  • sign
  • verify
  • wrapKey
  • unwrapKey
(Note that EC keys can only be used for signing and verification.)

The UpdateTags parameter determines whether the class replaces the key's current tags with the items in the Tag* properties (which may be empty). Keys may have up to 15 tags.

The ExpiryDate and NotBeforeDate configuration settings may also be used to send additional values, refer to their documentation for more information.

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
Cloud Keys 2020 macOS Edition - Version 20.0 [Build 7876]