Home Assistant Unofficial Reference 2024.12.1
homeassistant.helpers.config_entry_oauth2_flow.LocalOAuth2Implementation Class Reference
Inheritance diagram for homeassistant.helpers.config_entry_oauth2_flow.LocalOAuth2Implementation:
[legend]
Collaboration diagram for homeassistant.helpers.config_entry_oauth2_flow.LocalOAuth2Implementation:
[legend]

Public Member Functions

None __init__ (self, HomeAssistant hass, str domain, str client_id, str client_secret, str authorize_url, str token_url)
 
str async_generate_authorize_url (self, str flow_id)
 
dict async_resolve_external_data (self, Any external_data)
 
str domain (self)
 
dict extra_authorize_data (self)
 
str name (self)
 
str redirect_uri (self)
 
- Public Member Functions inherited from homeassistant.helpers.config_entry_oauth2_flow.AbstractOAuth2Implementation
dict async_refresh_token (self, dict token)
 

Public Attributes

 authorize_url
 
 client_id
 
 client_secret
 
 hass
 
 token_url
 

Private Member Functions

dict _async_refresh_token (self, dict token)
 
dict _token_request (self, dict data)
 

Private Attributes

 _domain
 

Detailed Description

Local OAuth2 implementation.

Definition at line 114 of file config_entry_oauth2_flow.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.helpers.config_entry_oauth2_flow.LocalOAuth2Implementation.__init__ (   self,
HomeAssistant  hass,
str  domain,
str  client_id,
str  client_secret,
str  authorize_url,
str  token_url 
)
Local OAuth2 implementation.
Initialize local auth implementation.

Definition at line 117 of file config_entry_oauth2_flow.py.

Member Function Documentation

◆ _async_refresh_token()

dict homeassistant.helpers.config_entry_oauth2_flow.LocalOAuth2Implementation._async_refresh_token (   self,
dict  token 
)
private

◆ _token_request()

dict homeassistant.helpers.config_entry_oauth2_flow.LocalOAuth2Implementation._token_request (   self,
dict  data 
)
private
Make a token request.

Definition at line 202 of file config_entry_oauth2_flow.py.

◆ async_generate_authorize_url()

str homeassistant.helpers.config_entry_oauth2_flow.LocalOAuth2Implementation.async_generate_authorize_url (   self,
str  flow_id 
)
Generate a url for the user to authorize.

Reimplemented from homeassistant.helpers.config_entry_oauth2_flow.AbstractOAuth2Implementation.

Definition at line 163 of file config_entry_oauth2_flow.py.

◆ async_resolve_external_data()

dict homeassistant.helpers.config_entry_oauth2_flow.LocalOAuth2Implementation.async_resolve_external_data (   self,
Any  external_data 
)
Resolve the authorization code to tokens.

Reimplemented from homeassistant.helpers.config_entry_oauth2_flow.AbstractOAuth2Implementation.

Definition at line 181 of file config_entry_oauth2_flow.py.

◆ domain()

str homeassistant.helpers.config_entry_oauth2_flow.LocalOAuth2Implementation.domain (   self)
Domain providing the implementation.

Reimplemented from homeassistant.helpers.config_entry_oauth2_flow.AbstractOAuth2Implementation.

Definition at line 140 of file config_entry_oauth2_flow.py.

◆ extra_authorize_data()

dict homeassistant.helpers.config_entry_oauth2_flow.LocalOAuth2Implementation.extra_authorize_data (   self)
Extra data that needs to be appended to the authorize url.

Definition at line 159 of file config_entry_oauth2_flow.py.

◆ name()

str homeassistant.helpers.config_entry_oauth2_flow.LocalOAuth2Implementation.name (   self)

◆ redirect_uri()

str homeassistant.helpers.config_entry_oauth2_flow.LocalOAuth2Implementation.redirect_uri (   self)
Return the redirect uri.

Definition at line 145 of file config_entry_oauth2_flow.py.

Member Data Documentation

◆ _domain

homeassistant.helpers.config_entry_oauth2_flow.LocalOAuth2Implementation._domain
private

Definition at line 128 of file config_entry_oauth2_flow.py.

◆ authorize_url

homeassistant.helpers.config_entry_oauth2_flow.LocalOAuth2Implementation.authorize_url

Definition at line 131 of file config_entry_oauth2_flow.py.

◆ client_id

homeassistant.helpers.config_entry_oauth2_flow.LocalOAuth2Implementation.client_id

Definition at line 129 of file config_entry_oauth2_flow.py.

◆ client_secret

homeassistant.helpers.config_entry_oauth2_flow.LocalOAuth2Implementation.client_secret

Definition at line 130 of file config_entry_oauth2_flow.py.

◆ hass

homeassistant.helpers.config_entry_oauth2_flow.LocalOAuth2Implementation.hass

Definition at line 127 of file config_entry_oauth2_flow.py.

◆ token_url

homeassistant.helpers.config_entry_oauth2_flow.LocalOAuth2Implementation.token_url

Definition at line 132 of file config_entry_oauth2_flow.py.


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