The listKeypair operation webservice in the TR31 module retrieves and TR31_SIGNING_KEYS java object(s) matching the webservice inputs and returns either the matching object or a list of matching objects in the response.
The listKeypair web service requires seven (7) 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. If none of the following values (kpid, keyid, status) are specified, this webservice will return a list of all keypairs created in this environment. Accepted values: |
|
kpid |
[Optional] The unique identifier of an existing keypair. If this value is not null, this webservice will attempt to return the keypair with this unique kpid value. |
|
keyid |
[Optional] Unique key identifier supplied by Apple's Business Registrar. If this value is not null, this webservice will attempt to return the keypair with this unique keyid value. |
|
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. If this value is not null, the above 3 values will search for keypairs matching the status provided by this value. If null, then status is ignored. Accepted values: |