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

Class AuthRequest

source code

object --+
         |
        AuthRequest

Instance Methods [hide private]
  __init__(self, endpoint, assoc)
Creates a new AuthRequest object.
  addExtensionArg(self, namespace, key, value)
Add an extension argument to this OpenID authentication request.
  redirectURL(self, trust_root, return_to, immediate=False)

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


Properties [hide private]

Inherited from object: __class__


Method Details [hide private]

__init__(self, endpoint, assoc)
(Constructor)

source code 

Creates a new AuthRequest object. This just stores each argument in an appropriately named field.

Users of this library should not create instances of this class. Instances of this class are created by the library when needed.
Overrides: object.__init__

addExtensionArg(self, namespace, key, value)

source code 

Add an extension argument to this OpenID authentication request.

Use caution when adding arguments, because they will be URL-escaped and appended to the redirect URL, which can easily get quite long.
Parameters:
  • namespace (str) - The namespace for the extension. For example, the simple registration extension uses the namespace sreg.
  • key (str) - The key within the extension namespace. For example, the nickname field in the simple registration extension's key is nickname.
  • value (str) - The value to provide to the server for this argument.

redirectURL(self, trust_root, return_to, immediate=False)

source code