/ 
eBay-API-0.25
River stage zero No dependents
/ eBay::API::XML::DataType::AuthenticationEntryType

NAME

eBay::API::XML::DataType::AuthenticationEntryType

DESCRIPTION

A set of application-level authentication preferences and related data that you configure to support the user authentication and authorization process.

SYNOPSIS

INHERITANCE

eBay::API::XML::DataType::AuthenticationEntryType inherits from the eBay::API::XML::BaseDataType class

Subroutines:

setAcceptURL()

A URL that you set up in order to determine when a user's authentication and authorization process succeeded. After a user signs into eBay and authorizes your application to execute secure calls on their behalf, eBay redirects the user's browser to this URL and, if TokenReturnMethod is set to Redirect, appends the user's authentication token plus other data that you specified to identify the user. This needs to be a secure https URL.

SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AuthNAuth Title: Authentication & Authorization MaxLength: 500

Calls: SetReturnURL
RequiredInput: No

# Argument: 'xs:anyURI'

getAcceptURL()

Calls: GetReturnURL
Returned: Conditionally

# Returns: 'xs:anyURI'

setPrivacyPolicyURL()

Your privacy policy URL, which is shown to end users on the eBay sign-in page.

SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AuthNAuth Title: Authentication & Authorization MaxLength: 500

Calls: SetReturnURL
RequiredInput: No

# Argument: 'xs:anyURI'

getPrivacyPolicyURL()

Calls: GetReturnURL
Returned: Conditionally

# Returns: 'xs:anyURI'

setRejectURL()

A URL that you set up in order to determine when a user's authentication and authorization process did not succeed. After a user signs into eBay but chooses NOT to authorize your application to execute secure calls on their behalf, eBay redirects the user's browser to this URL and appends data that you specified to identify the user (but does not return an authentication token). This needs to be a secure https URL.

SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AuthNAuth Title: Authentication & Authorization MaxLength: 500

Calls: SetReturnURL
RequiredInput: No

# Argument: 'xs:anyURI'

getRejectURL()

Calls: GetReturnURL
Returned: Conditionally

# Returns: 'xs:anyURI'

setRuName()

A unique identifier associated with application and the combination of URLs within this authentication entry. Unique across all applications that execute eBay Web Services calls. For convenience, you can call GetRuName to generate a unique value.

SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AuthNAuth Title: Authentication & Authorization MaxLength: 255

Calls: SetReturnURL
RequiredInput: Yes

# Argument: 'xs:string'

getRuName()

Calls: GetReturnURL
Returned: Always

# Returns: 'xs:string'

setTokenReturnMethod()

Specifies whether to return the token in the HTTP response stream sent to the accept URL, or to make it available for retrieval via FetchToken.

SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AuthNAuth Title: Authentication & Authorization

Calls: SetReturnURL
RequiredInput: No

# Argument: 'ns:TokenReturnMethodCodeType'

getTokenReturnMethod()

Calls: GetReturnURL
Returned: Conditionally

# Returns: 'ns:TokenReturnMethodCodeType'