Package openid :: Package consumer :: Module consumer :: Class SuccessResponse

Class SuccessResponse

object --+    
         |    
  Response --+
             |
            SuccessResponse

A response with a status of SUCCESS. Indicates that this request is a successful acknowledgement from the OpenID server that the supplied URL is, indeed controlled by the requesting agent.

Instance Methods

[hide private]

__init__(self, endpoint, message, signed_fields=None)
x.__init__(...) initializes x; see help(type(x)) for signature

source code

isOpenID1(self)
Was this authentication response an OpenID 1 authentication response?

source code

isSigned(self, ns_uri, ns_key)
Return whether a particular key is signed, regardless of its namespace alias

source code

getSigned(self, ns_uri, ns_key, default=None)
Return the specified signed field if available, otherwise return default

source code

getSignedNS(self, ns_uri)
Get signed arguments from the response message.

source code

extensionResponse(self, namespace_uri, require_signed)
Return response arguments in the specified namespace.

source code

str

getReturnTo(self)
Get the openid.return_to argument from this response.

source code

__eq__(self, other)

source code

__ne__(self, other)

source code

__repr__(self)
repr(x)

source code

Inherited from Response: getDisplayIdentifier, setEndpoint

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables

[hide private]

status = 'success'
SUCCESS

Instance Variables

[hide private]

OpenIDServiceEndpoint

endpoint
The endpoint that authenticated the identifier.

identity_url
The identity URL that has been authenticated; the Claimed Identifier.

signed_fields
The arguments in the server's response that were signed and verified.

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, endpoint, message, signed_fields=None)
(Constructor)

source code

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__: (inherited documentation)

getSignedNS(self, ns_uri)

source code

Get signed arguments from the response message. Return a dict of all arguments in the specified namespace. If any of the arguments are not signed, return None.

extensionResponse(self, namespace_uri, require_signed)

source code

Return response arguments in the specified namespace.

Parameters:

namespace_uri - The namespace URI of the arguments to be returned.
require_signed - True if the arguments should be among those signed in the response, False if you don't care.
If require_signed is True and the arguments are not signed, return None.

getReturnTo(self)

source code

Get the openid.return_to argument from this response.

This is useful for verifying that this request was initiated by this consumer.

Returns: str: The return_to URL supplied to the server on the initial request, or None if the response did not contain an openid.return_to argument.

repr(self)
(Representation operator)

source code

repr(x)

Overrides: object.__repr__: (inherited documentation)

Instance Variable Details

[hide private]

endpoint

The endpoint that authenticated the identifier. You may access other discovered information related to this endpoint, such as the CanonicalID of an XRI, through this object.

Type:: OpenIDServiceEndpoint

identity_url

The identity URL that has been authenticated; the Claimed Identifier. See also getDisplayIdentifier.

Class SuccessResponse

__init__(self, endpoint, message, signed_fields=None) (Constructor)

getSignedNS(self, ns_uri)

extensionResponse(self, namespace_uri, require_signed)

getReturnTo(self)

__repr__(self) (Representation operator)

endpoint

identity_url

init(self, endpoint, message, signed_fields=None)
(Constructor)

repr(self)
(Representation operator)