Skip to main content

This container stores metadata for a signing key.

Type that uses SigningKey

QuerySigningKeysResponse

Calls that use SigningKey

Fields

Field
Type
Description
creationTime
The UNIX timestamp when the SigningKey was created. This time is represented as the number of seconds from "1970-01-01T00:00:00Z", as measured in UTC, until the date and time the SigningKey was created.
expirationTime
The UNIX timestamp when the SigningKey expires. This time is represented as the number of seconds from "1970-01-01T00:00:00Z", as measured in UTC, until the date and time the SigningKey expires.
Note: All keys have an expiration date of three (3) years after their creationTime.
jwe
This is the JSON Web Encrypted (JWE) value for the publicKey.
privateKey
This is the Private Key that has been generated using the specified signingKeyCipher.
Note: The privateKey value will only be returned in the response payload of the createSigningKey method.

It will never be returned by the getSigningKey or getSigningKeys methods.
Developers are strongly advised to download their privateKey value as Privacy Enhance Mail (PEM) format and store it locally for future reference. In order to guarantee the security of confidential client information, eBay does not store privateKey values on any system.
Note: If a developer loses their privateKey they must generate new keypairs set using the createSigningKey method.
publicKey
This is the Public Key that has been generated using the specified signingKeyCipher.

As a matter of good practice, developers are strongly advised to download this value and store it locally for safe-keeping and future reference.
signingKeyCipher
Indicates the cipher used to create the keypairs. Refer to SigningKeyCiper for the list of supported enum values.
signingKeyId
The system-generated eBay ID for the keypairs.