fhirclient.auth.FHIRAuth Class Reference

Superclass to handle authorization flow and state. More...

Inheritance diagram for fhirclient.auth.FHIRAuth:

Public Member Functions
def	register (cls)
	Register this class to handle authorization types of the given type. More...
def	from_capability_security (cls, security, state=None)
	Supply a capabilitystatement.rest.security statement and this method will figure out which type of security should be instantiated. More...
def	create (cls, auth_type, state=None)
	Factory method to create the correct subclass for the given authorization type. More...
def	__init__ (self, state=None)
def	ready (self)
	Indicates whether the authorization part is ready to make resource requests. More...
def	reset (self)
def	can_sign_headers (self)
def	authorize_uri (self, server)
	Return the authorize URL to use, if any. More...
def	handle_callback (self, url, server)
	Return the launch context. More...
def	reauthorize (self)
	Perform a re-authorization of some form. More...
def	state (self)
def	from_state (self, state)
	Update ivars from given state information. More...

Public Attributes
	app_id

Static Public Attributes
string	auth_type = 'none'
dictionary	auth_classes = {}

Detailed Description

Superclass to handle authorization flow and state.

Constructor & Destructor Documentation

def fhirclient.auth.FHIRAuth.__init__	(		self,
			state = None
	)

Member Function Documentation

def fhirclient.auth.FHIRAuth.authorize_uri	(		self,
			server
	)

Return the authorize URL to use, if any.

def fhirclient.auth.FHIRAuth.can_sign_headers

(

self

)

def fhirclient.auth.FHIRAuth.create	(		cls,
			auth_type,
			state = None
	)

Factory method to create the correct subclass for the given authorization type.

def fhirclient.auth.FHIRAuth.from_capability_security	(		cls,
			security,
			state = None
	)

Supply a capabilitystatement.rest.security statement and this method will figure out which type of security should be instantiated.

:param security: A CapabilityStatementRestSecurity instance :param state: A settings/state dictionary :returns: A FHIRAuth instance or subclass thereof

def fhirclient.auth.FHIRAuth.from_state	(		self,
			state
	)

Update ivars from given state information.

def fhirclient.auth.FHIRAuth.handle_callback	(		self,
			url,
			server
	)

Return the launch context.

def fhirclient.auth.FHIRAuth.ready

(

self

)

Indicates whether the authorization part is ready to make resource requests.

def fhirclient.auth.FHIRAuth.reauthorize

(

self

)

Perform a re-authorization of some form.

:returns: The launch context dictionary or None on failure

def fhirclient.auth.FHIRAuth.register

(

cls

)

Register this class to handle authorization types of the given type.

def fhirclient.auth.FHIRAuth.reset

(

self

)

def fhirclient.auth.FHIRAuth.state

(

self

)

Member Data Documentation

fhirclient.auth.FHIRAuth.app_id

dictionary fhirclient.auth.FHIRAuth.auth_classes = {}

static

string fhirclient.auth.FHIRAuth.auth_type = 'none'

static

---

The documentation for this class was generated from the following file:

• fhirclient/auth.py