SecuritySchemeAttribute¶

1 min read

Import: import system.webapi;

Read the usage guide for examples and common tasks. This reference lists the public declarations for this part of the library. See Reading API signatures for parameter and result notation.

`SecuritySchemeAttribute`¶

Declares a dependency's OpenAPI authentication scheme.

public struct SecuritySchemeAttribute

`id`¶

Identifier used to reference this security scheme in OpenAPI.

public id: string

`kind`¶

OpenAPI scheme kind, such as http, apiKey, or oauth2.

public kind: string

`scheme`¶

HTTP authentication scheme, such as bearer.

public scheme: string

`name`¶

Name of the API-key header, query parameter, or cookie, when applicable.

public name: Option<string>

`location`¶

Where an API key is supplied: header, query, or cookie.

public location: Option<string>

SecuritySchemeAttribute¶