Product Documentation

The updateKek operation webservice in the TR31 module retrieves and TR31_KEY_ENCRYPTION_KEYS object(s) matching the webservice inputs and updates the matching object.


The updateKek web service requires ten (10) parameters:

did

The unique encryption domain identifier.

sid

The unique server identifier of the node in the StrongAuth KeyAppliance cluster that generated the KEK. This value is needed to search for the KEK to-be-updated by assembling the KEK's primary key.

svccred

The username (service credential) within the encryption domain with the authorization to call this web service. The credential requires the KMO and KMA privileges.

password

The password of the username to authenticate the credential of the requester.

environment

The environment in which this KEK is used.

Accepted values:
DEVELOPMENT, QA, PRODUCTION, NON_PRODUCTION, OTHER

kid

The unique identifier of an existing KEK. This value is needed to search for the KEK to-be-updated by assembling the KEK's primary key.

kcv

The first 6 characters of the CMAC KCV of the KEK. This value is needed to search for the KEK to-be-updated by assembling the KEK's primary key.

kekid

[Optional] Unique KEK identifier supplied by Apple's Business Registrar. If this value is null, this webservice will not update the found TR31_KEY_ENCRYPTION_KEYS DB record's keyid column.

status

[Optional] Status of the KEK record. If this value is null, this webservice will not update the found TR31_KEY_ENCRYPTION_KEYS DB record's status column.

Accepted values:
CURRENT, EXPIRED, OTHER

notes [Optional] notes that you can provide to store information about the KEK If this value is null, this webservice will not update the found TR31_KEY_ENCRYPTION_KEYS DB record's notes column.