Home | Trees | Index | Help |
|
---|
Package openid :: Package consumer :: Module consumer :: Class AuthRequest |
|
object
--+
|
AuthRequest
An object that holds the state necessary for generating an OpenID authentication request. This object holds the association with the server and the discovered information with which the request will be made.
It is separate from the consumer because you may wish to add things to the request before sending it on its way to the server. It also has serialization options that let you encode the authentication request as a URL or as a form POST.Method Summary | |
---|---|
Creates a new AuthRequest object. | |
Add an extension to this checkid request. | |
Add an extension argument to this OpenID authentication request. | |
Get html for a form to submit this request to the IDP. | |
openid.message.Message
|
Produce a openid.message.Message representing this
request. |
str |
Returns a URL with an encoded OpenID request. |
Set whether this request should be made anonymously. | |
bool |
Should this OpenID authentication request be sent as a HTTP redirect or as a POST (form submission)? |
Inherited from object :
__delattr__ ,
__getattribute__ ,
__hash__ ,
__new__ ,
__reduce__ ,
__reduce_ex__ ,
__repr__ ,
__setattr__ ,
__str__
|
Method Details |
---|
__init__(self,
endpoint,
assoc)
|
addExtension(self, extension_request)Add an extension to this checkid request.
|
addExtensionArg(self, namespace, key, value)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.
|
formMarkup(self, realm, return_to=None, immediate=False, form_tag_attrs=None)Get html for a form to submit this request to the IDP.
|
getMessage(self, realm, return_to=None, immediate=False)Produce aopenid.message.Message representing this
request.
|
redirectURL(self, realm, return_to=None, immediate=False)Returns a URL with an encoded OpenID request. The resulting URL is the OpenID provider's endpoint URL with parameters appended as query arguments. You should redirect the user agent to this URL. OpenID 2.0 endpoints also accept POST requests, see and .
|
setAnonymous(self, is_anonymous)Set whether this request should be made anonymously. If a request is anonymous, the identifier will not be sent in the request. This is only useful if you are making another kind of request with an extension in this request. Anonymous requests are not allowed when the request is made with OpenID 1.
|
shouldSendRedirect(self)Should this OpenID authentication request be sent as a HTTP redirect or as a POST (form submission)?
|
Home | Trees | Index | Help |
|
---|
Generated by Epydoc 2.1 on Fri Dec 14 16:10:53 2007 | http://epydoc.sf.net |