Skip to main content

Interface: ISecurityScheme

Properties of a SecurityScheme.

Extends​

Properties​

authorizationUrl?​

optional authorizationUrl?: string | null

The authorization URL to be used for this flow. This SHOULD be in the form of a URL. Valid for oauth2/implicit and oauth2/accessCode.

Inherited from​

$Properties.authorizationUrl

description?​

optional description?: string | null

A short description for security scheme.

Inherited from​

$Properties.description

extensions?​

optional extensions?: {[k: string]: $Properties; } | null

Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification. See: https://swagger.io/docs/specification/2-0/swagger-extensions/

Inherited from​

$Properties.extensions

flow?​

optional flow?: Flow | null

The flow used by the OAuth2 security scheme. Valid values are "implicit", "password", "application" or "accessCode". Valid for oauth2.

Inherited from​

$Properties.flow

in?​

optional in?: In | null

The location of the API key. Valid values are "query" or "header". Valid for apiKey.

Inherited from​

$Properties.in

name?​

optional name?: string | null

The name of the header or query parameter to be used. Valid for apiKey.

Inherited from​

$Properties.name

scopes?​

optional scopes?: $Properties | null

The available scopes for the OAuth2 security scheme. Valid for oauth2.

Inherited from​

$Properties.scopes

tokenUrl?​

optional tokenUrl?: string | null

The token URL to be used for this flow. This SHOULD be in the form of a URL. Valid for oauth2/password, oauth2/application and oauth2/accessCode.

Inherited from​

$Properties.tokenUrl

type?​

optional type?: Type | null

The type of the security scheme. Valid values are "basic", "apiKey" or "oauth2".

Inherited from​

$Properties.type