This method returns the Public Key, Public Key as JWE, and metadata for all keypairs associated with the application key making the call.
Note: It is important to note that
privateKey values are not returned. In order to further ensure the security of confidential client information, eBay does not store
privateKey values in any system. If a developer loses their
privateKey they must generate new keypairs set using the
This method is supported in Sandbox environment. To access the endpoint, just replace the
apiz.ebay.com root URI with
This method has no URI parameters.
HTTP request headers
All requests made to eBay REST operations require you to provide the
Authorization HTTP header for authentication authorization.
All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.
This request requires an access token created with the client credentials grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):
See OAuth access tokens for more information.
This call has no payload.
This call has no field definitions.
HTTP response headers
This call has no response headers.
|signingKeys||array of SigningKey|
An array of metadata information for keypairs owned by a user.
The UNIX timestamp when the
The UNIX timestamp when the
This is the JSON Web Encrypted (JWE) value for the
This is the Private Key that has been generated using the specified
This is the Public Key that has been generated using the specified
Indicates the cipher used to create the keypairs. Refer to SigningKeyCiper for the list of supported enum values.
The system-generated eBay ID for the keypairs.
HTTP status codes
This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.
|500||Internal Server Error|
For more on errors, plus the codes of other common errors, see Handling errors.
|210000||API_KEYS||APPLICATION||There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.|
|210005||API_KEYS||REQUEST||You must request with a token having valid application client id.|
This call has no warnings.
New to making API calls? Please see Making a Call.
Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.
Sample 1: Return all keypairs
This sample returns the Public Key, Public Key as JWE, and metadata for all keypairs associated with the application key making the call.
Note: It is important to note that Private Key values are not returned. In order to further ensure the security of confidential client information, eBay does not store any Private Key value in any system. If a developer loses their Private Key they must generate new keypairs using the
There is no request payload for this method.
A successful call returns the HTTP status code 200 OK.
The response payload includes the the Public Key, Public Key as JWE, and metadata for all keypairs associated with the application key making the call.