eBay · Schema

ClientSettings

This container stores application-specific information that is provided at the time of registration.

AuctionsCommerceProductsMarketplaceFortune 500

Properties

Name Type Description
client_name string User-friendly name for the third party financial application.

Note: Language tags are not supported. Therefore, client_name must be specified in En
contacts array 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 emai
policy_uri string 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.

<
redirect_uris array 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
software_id string 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 i
software_statement string The Software Statement Assertion (SSA) that has been issued by the OpenBanking identifier.

Note: This value must be Base64 encoded and not plain J
View JSON Schema on GitHub

JSON Schema

ebay-clientsettings-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ClientSettings",
  "title": "ClientSettings",
  "type": "object",
  "properties": {
    "client_name": {
      "type": "string",
      "description": "User-friendly name for the third party financial application.<br/><br/><span class=\"tablenote\"><b>Note:</b> Language tags are not supported. Therefore, <code>client_name</code> must be specified in English.</span>"
    },
    "contacts": {
      "type": "array",
      "description": "This container stores an array of email addresses that can be used to contact the registrant.<br/><br/><span class=\"tablenote\"><b>Note:</b> 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.</span>",
      "items": {
        "type": "string"
      }
    },
    "policy_uri": {
      "type": "string",
      "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.<br/><br/><span class=\"tablenote\"><b>Note:</b> Only HTTPS URLs are supported for <code>policy_uri</code> strings.</span><br/><span class=\"tablenote\"><b>Note:</b> This URL <b>must not</b> point to the eBay Privacy Policy.</span><br/>The value of this field <b>must</b> point to a valid and secure web page.<br/><br/><span class=\"tablenote\"><b>Note:</b> Language tags are not supported. Therefore, <code>policy_uri</code> will be displayed in English.</span>"
    },
    "redirect_uris": {
      "type": "array",
      "description": "An array of redirection URI strings for use in redirect-based flows such as the authorization code and implicit flows.<br/><br/><span class=\"tablenote\"><b>Note:</b> Only the first URI string from the list will be used.</span><span class=\"tablenote\"><b>Note:</b> Each redirection URI <b>must</b> be an absolute URI as defined by [RFC3986] Section 4.3.</span>",
      "items": {
        "type": "string"
      }
    },
    "software_id": {
      "type": "string",
      "description": "A unique identifier string assigned by the client developer or software publisher to identify the client software being registered.<br/><br/>Unlike <code>client_id</code> which should change between instances, the <CODE>software_id</code> should be the same value for all instances of the client software. That is, the <code>software_id</code> should remain unchanged across multiple updates or versions of the same piece of software. The value of this field is not intended to be human readable and is usually opaque to the client and authorization server."
    },
    "software_statement": {
      "type": "string",
      "description": "The Software Statement Assertion (SSA) that has been issued by the OpenBanking identifier.<br/><br/><span class=\"tablenote\"><b>Note:</b> This value <i>must be</i> <b>Base64</b> encoded and not plain JSON.</span>Refer to <a href=\"https://datatracker.ietf.org/doc/html/rfc7591#section-2.3 \" target= \"_blank \">RFC 7591 - OAuth 2.0 Dynamic Client Registration Protocol</a> for complete information."
    }
  },
  "description": "This container stores application-specific information that is provided at the time of registration."
}