Package openid :: Package consumer :: Module consumer :: Class SuccessResponse
[frames] | no frames]

Class SuccessResponse

source code

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, signed_args)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
  extensionResponse(self, prefix)
extract signed extension data from the server's response.
str getReturnTo(self)
Get the openid.return_to argument from this response.

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__


Class Methods [hide private]
  fromQuery(cls, endpoint, query, signed)

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
  signed_args
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, signed_args)
(Constructor)

source code 

x.__init__(...) initializes x; see x.__class__.__doc__ for signature
Overrides: object.__init__
(inherited documentation)

fromQuery(cls, endpoint, query, signed)
Class Method

source code 

extensionResponse(self, prefix)

source code 

extract signed extension data from the server's response.
Parameters:
  • prefix - The extension namespace from which to extract the extension data.

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.

Class Variable Details [hide private]

status


SUCCESS
Value:
'success'                                                              
      

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

signed_args


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