Product Documentation

The listKeks operation webservice in the TR31 module retrieves and TR31_KEY_ENCRYPTION_KEYS java object(s) matching the webservice inputs and returns either the matching object or a list of matching objects in the response.


The listKeks web service requires six (6) parameters:

did

The unique encryption domain identifier.

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. If the following value (kekId) is not specified, this webservice will return a list of all KEKs created in this environment.

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

kekId

The unique ID for the KEK supplied by Apple's Business Registrar.

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. If this value is not null, the above 2 values will search for KEKs matching the status provided by this value. If null, then status is ignored.

Accepted values:
CURRENT, EXPIRED, OTHER