Skip to content

hololinked.client.security.APIKeySecurity

Bases: BaseModel

API Key Security Scheme. The API key is added into a header named X-API-Key.

Source code in hololinked/hololinked/client/security.py
class APIKeySecurity(BaseModel):
    """
    API Key Security Scheme.
    The API key is added into a header named `X-API-Key`.
    """

    value: str
    http_header_name: str = "X-API-Key"

    @property
    def http_header(self) -> str:
        return self.value

Attributes

value instance-attribute

value: str

http_header_name class-attribute instance-attribute

http_header_name: str = 'X-API-Key'