Client Registration API — client.developer.client_registration¶
Version v1.0.0 · base path /developer/registration/v1 · async twin: the same methods on
AsyncEbayClient, awaited.
Operations¶
Bases: BaseResource
register_client ¶
register_client(*, body: ClientSettings, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> developer_client_registration_models.ClientDetails
register_client(*, body: ClientSettings, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
register_client(*, body: ClientSettings, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> developer_client_registration_models.ClientDetails | httpx.Response
Registers a new third party financial application with eBay.
Models¶
ClientDetails ¶
Bases: EbayModel
client_id
class-attribute
instance-attribute
¶
client_id = Field(None, description='A unique, eBay-generated id assigned to the third party application at the time it was registered.')
client_id_issued_at
class-attribute
instance-attribute
¶
client_id_issued_at = Field(None, description='The UNIX timestamp when the client_id was issued. This time is represented as the number of seconds from "1970-01-01T00:00:00Z", as measured in UTC, until the date/time of issuance. Refer to RFC 7591 - OAuth 2.0 Dynamic Client Registration Protocol for complete information.')
client_name
class-attribute
instance-attribute
¶
client_name = Field(None, description='User-friendly name for the third party financial application. Note: Language tags are not supported. Therefore, client_name will be specified in English.')
client_secret
class-attribute
instance-attribute
¶
client_secret = Field(None, description='A unique OAuth 2.0 secret string assigned by eBay to the third party application at the time it is registered. This value should be unique for multiple instances of a client using the same client_id . This value is used by confidential clients to authenticate to the token endpoint, as described in OAuth 2.0 [RFC6749], Section 2.3.1.')
client_secret_expires_at
class-attribute
instance-attribute
¶
client_secret_expires_at = Field(None, description='The UNIX timestamp when the client_secret expires. Note: When a client_secret has been provided, this field is REQUIRED . A returned value of 0 indicates that the client_secret never expires. This time is represented as the number of seconds from "1970-01-01T00:00:00Z", as measured in UTC, until the expiration date and time.')
contacts
class-attribute
instance-attribute
¶
contacts = Field(None, description='This container stores an array of email addresses for representatives at the third party provider responsible for the application being registered.')
grant_types
class-attribute
instance-attribute
¶
grant_types = Field(None, description='An array of OAuth 2.0 grant type strings that the client software can use at the token endpoint. Supported grant type values are: authorization_code : The authorization code grant type defined in OAuth 2.0, Section 4.1. client_credentials : The client credentials grant type defined in OAuth 2.0, Section 4.4.')
policy_uri
class-attribute
instance-attribute
¶
policy_uri = Field(None, description='The URL string pointing to a human-readable privacy policy document that describes how the third party provider collects, uses, retains, and discloses personal data. Note: Only HTTPS URLs are supported for policy_uri strings. Note: This URL must not point to the eBay Privacy Policy. The authorization server should display this secure URL to the end-user if it is provided.')
redirect_uris
class-attribute
instance-attribute
¶
redirect_uris = Field(None, description='An eBay system-generated value assigned to the application. This value represents the redirect uri(s) submitted by the user either in the request payload (i.e., the redirect_uris field,) or the software_statement .')
scope
class-attribute
instance-attribute
¶
scope = Field(None, description='String containing a space-separated list of scope values (as described in Section 3.3 of OAuth 2.0 [RFC6749]) that the client can use when requesting access tokens. The semantics of values in this list are service specific.')
software_id
class-attribute
instance-attribute
¶
software_id = Field(None, description='A unique identifier string provided by the client developer or software publisher at the time of registration that identifies the client software being registered. Unlike client_id which should change between instances, the software_id should be the same value for all instances of the client software.')
software_statement
class-attribute
instance-attribute
¶
software_statement = Field(None, description='The Software Statement Assertion (SSA), a JSON Web Token (JWT), that has been issued by the OpenBanking identifier. Refer to RFC 7591 - OAuth 2.0 Dynamic Client Registration Protocol for complete information.')
ClientSettings ¶
Bases: EbayModel
client_name
class-attribute
instance-attribute
¶
client_name = Field(None, description='User-friendly name for the third party financial application. Note: Language tags are not supported. Therefore, client_name must be specified in English.')
contacts
class-attribute
instance-attribute
¶
contacts = Field(None, description="This container stores an array of email addresses that can be used to contact the registrant. Note: When more than one email address is provided, the first email in the array will be used as the developer account's email address. All other email addresses will be used as general contact information.")
policy_uri
class-attribute
instance-attribute
¶
policy_uri = Field(None, description='The URL string pointing to a human-readable privacy policy document that describes how the third party provider collects, uses, retains, and discloses personal data. Note: Only HTTPS URLs are supported for policy_uri strings. Note: This URL must not point to the eBay Privacy Policy. The value of this field must point to a valid and secure web page. Note: Language tags are not supported.')
redirect_uris
class-attribute
instance-attribute
¶
redirect_uris = Field(None, description='An array of redirection URI strings for use in redirect-based flows such as the authorization code and implicit flows. Note: Only the first URI string from the list will be used. Note: Each redirection URI must be an absolute URI as defined by [RFC3986] Section 4.3.')
software_id
class-attribute
instance-attribute
¶
software_id = Field(None, description='A unique identifier string assigned by the client developer or software publisher to identify the client software being registered. Unlike client_id which should change between instances, the software_id should be the same value for all instances of the client software. That is, the software_id should remain unchanged across multiple updates or versions of the same piece of software.')
software_statement
class-attribute
instance-attribute
¶
software_statement = Field(None, description='The Software Statement Assertion (SSA) that has been issued by the OpenBanking identifier. Note: This value must be Base64 encoded and not plain JSON. Refer to RFC 7591 - OAuth 2.0 Dynamic Client Registration Protocol for complete information.')
Error1 ¶
Bases: OpenStrEnum
invalid_contact_email
class-attribute
instance-attribute
¶
invalid_contact_email = 'invalid_contact_email'
invalid_software_statement
class-attribute
instance-attribute
¶
invalid_software_statement = 'invalid_software_statement'
invalid_redirect_uri
class-attribute
instance-attribute
¶
invalid_redirect_uri = 'invalid redirect_uri'
internal_server_error
class-attribute
instance-attribute
¶
internal_server_error = 'internal_server_error'
maximum_limit_keysets_reached
class-attribute
instance-attribute
¶
maximum_limit_keysets_reached = 'maximum_limit_keysets_reached'
caller_not_registered
class-attribute
instance-attribute
¶
caller_not_registered = 'caller_not_registered'
certificate_expired
class-attribute
instance-attribute
¶
certificate_expired = 'certificate_expired'
certificate_revoked
class-attribute
instance-attribute
¶
certificate_revoked = 'certificate_revoked'
invalid_certificate
class-attribute
instance-attribute
¶
invalid_certificate = 'invalid_certificate'
missing_certificate
class-attribute
instance-attribute
¶
missing_certificate = 'missing_certificate'
certificate_validation_error
class-attribute
instance-attribute
¶
certificate_validation_error = 'certificate_validation_error'
internal_service_error
class-attribute
instance-attribute
¶
internal_service_error = 'internal_service_error'
Error ¶
Bases: EbayModel
ClientRegistrationErrorEnum ¶
Bases: OpenStrEnum
invalid_contact_email
class-attribute
instance-attribute
¶
invalid_contact_email = 'invalid_contact_email'
invalid_software_statement
class-attribute
instance-attribute
¶
invalid_software_statement = 'invalid_software_statement'
invalid_redirect_uri
class-attribute
instance-attribute
¶
invalid_redirect_uri = 'invalid redirect_uri'
internal_server_error
class-attribute
instance-attribute
¶
internal_server_error = 'internal_server_error'
maximum_limit_keysets_reached
class-attribute
instance-attribute
¶
maximum_limit_keysets_reached = 'maximum_limit_keysets_reached'
caller_not_registered
class-attribute
instance-attribute
¶
caller_not_registered = 'caller_not_registered'
certificate_expired
class-attribute
instance-attribute
¶
certificate_expired = 'certificate_expired'
certificate_revoked
class-attribute
instance-attribute
¶
certificate_revoked = 'certificate_revoked'
invalid_certificate
class-attribute
instance-attribute
¶
invalid_certificate = 'invalid_certificate'
missing_certificate
class-attribute
instance-attribute
¶
missing_certificate = 'missing_certificate'
certificate_validation_error
class-attribute
instance-attribute
¶
certificate_validation_error = 'certificate_validation_error'
internal_service_error
class-attribute
instance-attribute
¶
internal_service_error = 'internal_service_error'