Skip to content

SecuritySchemaComponent

faststream.asyncapi.schema.security.SecuritySchemaComponent #

Bases: BaseModel

A class to represent a security schema component.

bearerFormat class-attribute instance-attribute #

bearerFormat: Optional[str] = None

description class-attribute instance-attribute #

description: Optional[str] = None

flows class-attribute instance-attribute #

flows: Optional[OauthFlows] = None

in_ class-attribute instance-attribute #

in_: Optional[str] = Field(default=None, alias='in')

model_config class-attribute instance-attribute #

model_config = {'extra': 'allow'}

name class-attribute instance-attribute #

name: Optional[str] = None

openIdConnectUrl class-attribute instance-attribute #

openIdConnectUrl: Optional[str] = None

schema_ class-attribute instance-attribute #

schema_: Optional[str] = Field(default=None, alias='schema')

type instance-attribute #

type: Literal['userPassword', 'apikey', 'X509', 'symmetricEncryption', 'asymmetricEncryption', 'httpApiKey', 'http', 'oauth2', 'openIdConnect', 'plain', 'scramSha256', 'scramSha512', 'gssapi']

Config #

extra class-attribute instance-attribute #

extra = 'allow'