Product Documentation

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


The updateKeypair web service requires ten (10) 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 keypair is used.

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

sid

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

kpid

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

keyid

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

keytoken

[Optional] Token number received from escrowing keypair’s private key. If this value is null, this webservice will not update the found TR31_SIGNING_KEYPAIRS DB record's keytoken column.

status

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

Accepted values:
CURRENT, EXPIRED, OTHER

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