Key Management API — client.developer.key_management¶
Version v1.0.0 · base path /developer/key_management/v1 · async twin: the same methods on
AsyncEbayClient, awaited.
Operations¶
Bases: BaseResource
get_signing_keys ¶
get_signing_keys(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> developer_key_management_models.QuerySigningKeysResponse
get_signing_keys(*, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_signing_keys(*, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> developer_key_management_models.QuerySigningKeysResponse | httpx.Response
Retrieves keypairs and metadata for all keypairs associated with the application key making the call.
create_signing_key ¶
create_signing_key(*, body: CreateSigningKeyRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> developer_key_management_models.SigningKey
create_signing_key(*, body: CreateSigningKeyRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
create_signing_key(*, body: CreateSigningKeyRequest, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> developer_key_management_models.SigningKey | httpx.Response
Creates keypairs using the selected cipher.
get_signing_key ¶
get_signing_key(signing_key_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> developer_key_management_models.SigningKey
get_signing_key(signing_key_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_signing_key(signing_key_id: str, *, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> developer_key_management_models.SigningKey | httpx.Response
Retrieves a specific keypair and metadata for a specified signing key ID associated with the application key making the call.
Models¶
ErrorParameter ¶
SigningKeyCipher ¶
CreateSigningKeyRequest ¶
Bases: EbayModel
signing_key_cipher
class-attribute
instance-attribute
¶
signing_key_cipher = Field(None, alias='signingKeyCipher', description='The enumerated value for the cipher to be used to create the signing key. Refer to SigningKeyCipher for the list of supported enum values.')
Error ¶
Bases: EbayModel
category
class-attribute
instance-attribute
¶
category = Field(None, description='Identifies the type of error.')
domain
class-attribute
instance-attribute
¶
domain = Field(None, description='Name for the primary system where the error occurred. This is relevant for application errors.')
error_id
class-attribute
instance-attribute
¶
error_id = Field(None, alias='errorId', description='A unique number to identify the error.')
input_ref_ids
class-attribute
instance-attribute
¶
input_ref_ids = Field(None, alias='inputRefIds', description='An array of request elements most closely associated to the error.')
long_message
class-attribute
instance-attribute
¶
long_message = Field(None, alias='longMessage', description='A more detailed explanation of the error.')
message
class-attribute
instance-attribute
¶
message = Field(None, description="Information on how to correct the problem, in the end user's terms and language where applicable.")
output_ref_ids
class-attribute
instance-attribute
¶
output_ref_ids = Field(None, alias='outputRefIds', description='An array of request elements most closely associated to the error.')
parameters
class-attribute
instance-attribute
¶
parameters = Field(None, description='An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned.')
subdomain
class-attribute
instance-attribute
¶
subdomain = Field(None, description='Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc.')
SigningKey ¶
Bases: EbayModel
creation_time
class-attribute
instance-attribute
¶
creation_time = Field(None, alias='creationTime', description='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.')
expiration_time
class-attribute
instance-attribute
¶
expiration_time = Field(None, alias='expirationTime', description='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
class-attribute
instance-attribute
¶
jwe = Field(None, description='This is the JSON Web Encrypted (JWE) value for the publicKey .')
private_key
class-attribute
instance-attribute
¶
private_key = Field(None, alias='privateKey', description='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.')
public_key
class-attribute
instance-attribute
¶
public_key = Field(None, alias='publicKey', description='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.')
signing_key_cipher
class-attribute
instance-attribute
¶
signing_key_cipher = Field(None, alias='signingKeyCipher', description='Indicates the cipher used to create the keypairs. Refer to SigningKeyCipher for the list of supported enum values.')
signing_key_id
class-attribute
instance-attribute
¶
signing_key_id = Field(None, alias='signingKeyId', description='The system-generated eBay ID for the keypairs.')