login - Call Reference - Open eBay Identity Provider API

Requests an EIDP token, which will enable your application to make calls and to authenticate incoming calls from the eBay.

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

<?xml version="1.0" encoding="utf-8"?>
<loginResponse xmlns="http://www.ebay.com/marketplace/services">
  <!-- Standard Output Fields -->
  <ack> AckValue </ack>
  <errorMessage> ErrorMessage
    <error> ErrorData
      <category> ErrorCategory </category>
      <domain> string </domain>
      <errorId> long </errorId>
      <exceptionId> token </exceptionId>
      <message> string </message>
      <parameter name="string"> ErrorParameter (string) </parameter>
      <!-- ... more parameter nodes here ... -->
      <severity> ErrorSeverity </severity>
      <subdomain> string </subdomain>
    </error>
    <!-- ... more error nodes here ... -->
  </errorMessage>
  <timestamp> dateTime </timestamp>
  <version> string </version>
  <!-- Call-specific Output Fields -->
  <securityToken type="OpeneBayTokenType" issuingAuthority="string" expirationDate="dateTime" type="OpeneBayTokenType" issuingAuthority="string" expirationDate="dateTime"> OpeneBaySecurityTokenType
    <tokenValue> string </tokenValue>
  </securityToken>
</loginResponse>

Return Value	Type	Occurrence	Meaning

Standard Output Fields [Jump to call-specific fields]

ack	AckValue	Always	Applicable values: • Failure (out) The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data. • PartialFailure (out) The request that triggered the error was processed successfully but with some warnings. • Success (out) The request was processed successfully, but something occurred that may affect your application or the user. • Warning (out) The request that triggered the error was processed successfully but with some warnings.
errorMessage	ErrorMessage	Conditionally	Information for an error or warning that occurred when eBay processed the request.
errorMessage.error	ErrorData	Conditionally, repeatable: [0..*]	ActivityProfile about a single error.
errorMessage.error.category	ErrorCategory	Conditionally	There are three categories of errors: request errors, application errors, and system errors. Applicable values: • Application (out) An error occurred due to a problem with the request, such as missing or invalid fields. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. Once the problem in the application or data is resolved, resend the corrected request to eBay. • Request (out) An error occurred due to a problem with the request, such as invalid or missing data. The problem must be corrected before the request can be made again. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the data is resolved, resend the request to eBay with the corrected data. • System (out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.
errorMessage.error.domain	string	Conditionally	Name of the domain in which the error occurred. Domains include: Marketplace A business or validation error occurred for the UserProfile Service. SOA An exception occurred in the Service Oriented Architecture (SOA) framework.
errorMessage.error.errorId	long	Conditionally	A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error- handling algorithms.
errorMessage.error.exceptionId	token	Conditionally	Unique identifier for an exception associated with an error.
errorMessage.error.message	string	Conditionally	A detailed description of the condition that resulted in the error.
errorMessage.error.parameter	ErrorParameter (string)	Conditionally, repeatable: [0..*]	Some warning and error messages return one or more variables that contain contextual information about the error. This is often the field or value that triggered the error.
errorMessage.error.parameter [ attribute name ]	string	Conditionally	The name of the parameter in the list of parameter types returned within the error type.
errorMessage.error.severity	ErrorSeverity	Conditionally	Indicates whether the error caused the request to fail (Error) or not (Warning). If the request fails and the source of the problem is within the application (such as a missing required element), please change the application before you retry the request. If the problem is due to end-user input data, please alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, you can attempt to re- send the request to eBay. If the source of the problem is on eBay's side, you can retry the request as- is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form. When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future. Applicable values: • Error (out) The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data. • Warning (out) The request was processed successfully, but something occurred that may affect your application or the user. For example, eBay may have changed a value the user sent in. In this case, eBay returns a normal, successful response and also returns the warning.
errorMessage.error.subdomain	string	Conditionally	Name of the subdomain in which the error occurred. Subdomains include: UserProfile The error is specific to the UserProfile service. MarketplaceCommon The error is common to all Marketplace services.
timestamp	dateTime	Always	The date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM- DDTHH:MM:SS.SSSZ). See Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone.
version	string	Always	Open eBay version.

Call-specific Output Fields

securityToken	OpeneBaySecurityTokenType	Always	Container for EIDP token, returned as part of the response to the login call. Your application then uses this token in calls to the Open eBay Subscription service and to the Open eBay Application Integration service.
securityToken [ attribute type ]	OpeneBayTokenType	Always	Base type for tokens. For a list of possible enumeration values, see OpeneBayTokenType.
securityToken [ attribute issuingAuthority ]	string	Always	Issuing authority for the token. Value is eBay.
securityToken [ attribute expirationDate ]	dateTime	Always	The time and date that the EIDP token expires (typically, 24 hours after issuance).
securityToken [ attribute type ]	OpeneBayTokenType	Always	Base type for tokens. For a list of possible enumeration values, see OpeneBayTokenType.
securityToken [ attribute issuingAuthority ]	string	Always	Issuing authority for the token. Value is eBay.
securityToken [ attribute expirationDate ]	dateTime	Always	The time and date that the EIDP token expires (typically, 24 hours after issuance).
securityToken.tokenValue	string	Always	The EIDP token identifying the third-party application. Obtained using the login request. Max length: 2000.

New to making API calls? Please see Making an API Call.

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Sample: Basic Call

Requests an Open eBay Identity Provider token that will enable your application to make Open eBay calls and to authenticate incoming calls from the Open eBay Framework.

Description

An application is requesting an EIDP token.

Input

XML format (HTTP POST). Also available is the .txt version of this XML.

<?xml version="1.0" encoding="UTF-8"?>
<loginRequest xmlns="http://www.ebay.com/marketplace/services">
   <credential appId="echo15App">
      <certId>MyCertId</certId>
   </credential>
   <accept by="Value"/>
   <attributes>
      <attribute name="devId">
         <attributeValue>MyDevId</attributeValue>
      </attribute>
   </attributes>
</loginRequest>

Output

XML format. Also available is the .txt version of this XML.

<?xml version="1.0" encoding="UTF-8"?>
<loginResponse xmlns="http://www.ebay.com/marketplace/services">
   <ack>Success</ack>
   <version>1.0.0</version>
   <timestamp>2009-07-14T23:42:13.009Z</timestamp>
   <securityToken expirationDate="2009-07-15T16:42:12.993-07:00" issuingAuthority="eBay">
      <tokenValue>EIDPToken</tokenValue>
   </securityToken>
</loginResponse>

Version	Description
1.0.0 2009-07-27	(added) New call

User-Contributed Notes

This document was generated with a customized version of the apireferencedocs tool.

accept	OpeneBayAcceptType	Required	Specifies whether acceptance will be based on a token passed by value or by reference.
accept [ attribute by ]	OpeneBayTokenType	Optional	Specifies whether a token is passed by reference or by value. For a list of possible enumeration values, see OpeneBayTokenType.
attributes	OpeneBayAssertionAttributesType	Required	The identity assertions submitted at login include CertID and AppID.
attributes.attribute	OpeneBayAssertionAttributeType	Required, repeatable: [1..*]	Container for the identity assertions used in the login call.
attributes.attribute [ attribute name ]	string	Required	Specifies which identity assertion is used in the login call. For example, DevID.
attributes.attribute .attributeValue	string	Required	Contains the values of the identity assertion, usually a DevID, used in the login call.
credential	OpeneBayLoginCredentialsType	Required	Specifies the type of credentials offered in the login request.
credential [ attribute appId ]	string	Required	AppID, or fully-qualified name of an application as required in the deployment descriptor. This value must be structured as ApplicationName.PlatformName.TopDomain.
credential [ attribute appId ]	string	Required	AppID, or fully-qualified name of an application as required in the deployment descriptor. This value must be structured as ApplicationName.PlatformName.TopDomain.
credential.certId	string	Required	The certID is generated by eBay and provided to third parties. Third parties use the certId to log into eBay through the EIDP service. Max length: 128.

Open eBay Identity Provider Call Reference Version 1.0.0

Open eBay Identity Provider
Call Reference Version 1.0.0