api-typescript-generator / Modules / openapi / OpenApiSecurityScheme
openapi.OpenApiSecurityScheme
OpenAPI Security Scheme Object.
See
https://swagger.io/specification/#security-scheme-object
• Optional bearerFormat: string
A hint to the client to identify how the bearer token is formatted. Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes.
• Optional description: string
A short description for security scheme.
• Optional flows: OpenApiOAuthFlows
An object containing configuration information for the flow types supported.
• Optional in: "query" | "header" | "cookie"
The location of the API key. Valid values are "query", "header" or "cookie".
• Optional name: string
The name of the header, query or cookie parameter to be used.
• Optional openIdConnectUrl: string
OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.
• Optional scheme: string
The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.
• type: "apiKey" | "http" | "mutualTLS" | "oauth2" | "openIdConnect"
The type of the security scheme. Valid values are "apiKey", "http", "oauth2", "openIdConnect".