AAS HTTP Client Documentation
Loading...
Searching...
No Matches
config_classes.BasicAuth Class Reference

Basic Authentication Configuration. More...

Inheritance diagram for config_classes.BasicAuth:
[legend]
Collaboration diagram for config_classes.BasicAuth:
[legend]

Public Member Functions

bool is_active (self)
 Check if the basic authentication is active.
 
None set_password (self, str password)
 Set the password for the basic authentication.
 
str get_password (self)
 Get the password for the basic authentication.
 

Static Public Attributes

str username = Field(default="", alias="Username", description="Username for the basic authentication.")
 

Protected Attributes

 _password
 

Static Protected Attributes

str _password = PrivateAttr(default="")
 

Detailed Description

Basic Authentication Configuration.

Parameters
BaseModelPydantic BaseModel for data validation.

Definition at line 40 of file config_classes.py.

Member Function Documentation

◆ get_password()

str config_classes.BasicAuth.get_password (   self)

Get the password for the basic authentication.

Returns
The password.

Definition at line 63 of file config_classes.py.

◆ is_active()

bool config_classes.BasicAuth.is_active (   self)

Check if the basic authentication is active.

Returns
True if the username is not empty, False otherwise.

Definition at line 49 of file config_classes.py.

◆ set_password()

None config_classes.BasicAuth.set_password (   self,
str  password 
)

Set the password for the basic authentication.

Parameters
passwordPassword for the basic authentication.

Definition at line 56 of file config_classes.py.

Member Data Documentation

◆ _password [1/2]

str config_classes.BasicAuth._password = PrivateAttr(default="")
staticprotected

Definition at line 43 of file config_classes.py.

◆ _password [2/2]

config_classes.BasicAuth._password
protected

Definition at line 50 of file config_classes.py.

◆ username

str config_classes.BasicAuth.username = Field(default="", alias="Username", description="Username for the basic authentication.")
static

Definition at line 42 of file config_classes.py.


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