config_classes.OAuth Class Reference

Open Authentication Configuration. More...

Inheritance diagram for config_classes.OAuth:

Collaboration diagram for config_classes.OAuth:

Public Member Functions
bool	is_active (self)
	Check if the service provider authentication is active.
None	set_client_secret (self, str client_secret)
	Set the client secret for the authentication.
str	get_client_secret (self)
	Get the client secret for the authentication.

Public Attributes
	token_url

Static Public Attributes
str	token_url = Field(default="", alias="TokenUrl", description="Endpoint URL for the token request.")
str	client_id = Field(default="", alias="ClientId", description="Client identifier for authentication.")
str	grant_type = Field(default="client_credentials", alias="GrantType", description="Grant type for the authentication.")
str	header_name = Field(default="Authorization", alias="HeaderName", description="Header name for the authentication.")

Protected Attributes
	_client_secret

Static Protected Attributes
str	_client_secret = PrivateAttr(default="")

Detailed Description

Open Authentication Configuration.

Parameters

BaseModel

Pydantic BaseModel for data validation.

Definition at line 71 of file config_classes.py.

Member Function Documentation

get_client_secret()

str config_classes.OAuth.get_client_secret

(

self

)

Get the client secret for the authentication.

Returns

The client secret.

Definition at line 97 of file config_classes.py.

is_active()

bool config_classes.OAuth.is_active

(

self

)

Check if the service provider authentication is active.

Returns

True if the client ID is not empty, False otherwise.

Definition at line 83 of file config_classes.py.

set_client_secret()

None config_classes.OAuth.set_client_secret	(		self,
		str	client_secret
	)

Set the client secret for the authentication.

Parameters

client_secret

Client secret for the authentication.

Definition at line 90 of file config_classes.py.

Member Data Documentation

_client_secret [1/2]

str config_classes.OAuth._client_secret = PrivateAttr(default="")

staticprotected

Definition at line 77 of file config_classes.py.

_client_secret [2/2]

config_classes.OAuth._client_secret

protected

Definition at line 91 of file config_classes.py.

client_id

str config_classes.OAuth.client_id = Field(default="", alias="ClientId", description="Client identifier for authentication.")

static

Definition at line 74 of file config_classes.py.

grant_type

str config_classes.OAuth.grant_type = Field(default="client_credentials", alias="GrantType", description="Grant type for the authentication.")

static

Definition at line 75 of file config_classes.py.

header_name

str config_classes.OAuth.header_name = Field(default="Authorization", alias="HeaderName", description="Header name for the authentication.")

static

Definition at line 76 of file config_classes.py.

token_url [1/2]

str config_classes.OAuth.token_url = Field(default="", alias="TokenUrl", description="Endpoint URL for the token request.")

static

Definition at line 73 of file config_classes.py.

token_url [2/2]

config_classes.OAuth.token_url

Definition at line 84 of file config_classes.py.

---

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

• aas_http_client/classes/Configuration/config_classes.py