fhirclient.auth.FHIRAuth Class Reference

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

Inheritance diagram for fhirclient.auth.FHIRAuth:

Public Member Functions
	register (cls)
	Register this class to handle authorization types of the given type.
	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.
	create (cls, auth_type, state=None)
	Factory method to create the correct subclass for the given authorization type.
	__init__ (self, state=None)
	reset (self)
	can_sign_headers (self)
	authorize_uri (self, server)
	Return the authorize URL to use, if any.
	handle_callback (self, url, server)
	Return the launch context.
	reauthorize (self)
	Perform a re-authorization of some form.
	from_state (self, state)
	Update ivars from given state information.

Public Attributes
	auth_type
	app_id

Static Public Attributes
str	auth_type = 'none'
dict	auth_classes = {}

Properties
	ready = property
	Indicates whether the authorization part is ready to make resource requests.
	state = property

Detailed Description

Superclass to handle authorization flow and state.

Constructor & Destructor Documentation

__init__()

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

Reimplemented in fhirclient.auth.FHIROAuth2Auth.

Member Function Documentation

authorize_uri()

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

Return the authorize URL to use, if any.

Reimplemented in fhirclient.auth.FHIROAuth2Auth.

can_sign_headers()

fhirclient.auth.FHIRAuth.can_sign_headers

(

self

)

Reimplemented in fhirclient.auth.FHIROAuth2Auth.

create()

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

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

from_capability_security()

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.

Parameters

security	A CapabilityStatementRestSecurity instance
state	A settings/state dictionary

Returns

s A FHIRAuth instance or subclass thereof

from_state()

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

Update ivars from given state information.

Reimplemented in fhirclient.auth.FHIROAuth2Auth.

handle_callback()

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

Return the launch context.

Reimplemented in fhirclient.auth.FHIROAuth2Auth.

reauthorize()

fhirclient.auth.FHIRAuth.reauthorize

(

self

)

Perform a re-authorization of some form.

Returns

s The launch context dictionary or None on failure

Reimplemented in fhirclient.auth.FHIROAuth2Auth.

register()

fhirclient.auth.FHIRAuth.register

(

cls

)

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

reset()

fhirclient.auth.FHIRAuth.reset

(

self

)

Reimplemented in fhirclient.auth.FHIROAuth2Auth.

Member Data Documentation

app_id

fhirclient.auth.FHIRAuth.app_id

auth_classes

dict fhirclient.auth.FHIRAuth.auth_classes = {}

static

auth_type [1/2]

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

static

auth_type [2/2]

fhirclient.auth.FHIRAuth.auth_type

Property Documentation

ready

fhirclient.auth.FHIRAuth.ready = property

static

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

state

fhirclient.auth.FHIRAuth.state = property

static

---

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

• fhirclient/auth.py