Skip to main content

Interface: $Properties

options.SecurityScheme.$Properties

Properties of a SecurityScheme.

Hierarchy​

Properties​

authorizationUrl​

• Optional authorizationUrl: null | string

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.

description​

• Optional description: null | string

A short description for security scheme.

extensions​

• Optional extensions: null | { [k: string]: $Properties; }

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/

flow​

• Optional flow: null | Flow

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

in​

• Optional in: null | In

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

name​

• Optional name: null | string

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

scopes​

• Optional scopes: null | $Properties

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

tokenUrl​

• Optional tokenUrl: null | string

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.

type​

• Optional type: null | Type

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