api-morph / SecuritySchemeObject

Interface: SecuritySchemeObject

Defined in: src/types/openapi.ts:1140

Defines a security scheme that can be used by the operations.

See

https://spec.openapis.org/oas/v3.1.1#security-scheme-object

Indexable

[key: `x-${string}`]: any

This object MAY be extended with Specification Extensions.

Properties

bearerFormat?

optional bearerFormat: string

Defined in: src/types/openapi.ts:1177

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. (Applies to: http ("bearer"))

---

description?

optional description: string

Defined in: src/types/openapi.ts:1150

A description for security scheme. CommonMark syntax MAY be used for rich text representation.

---

flows?

optional flows: OAuthFlowsObject

Defined in: src/types/openapi.ts:1183

REQUIRED. An object containing configuration information for the flow types supported. (Applies to: oauth2)

---

in?

optional in: "query" | "header" | "cookie"

Defined in: src/types/openapi.ts:1162

REQUIRED. The location of the API key. Valid values are "query", "header", or "cookie". (Applies to: apiKey)

---

name?

optional name: string

Defined in: src/types/openapi.ts:1156

REQUIRED. The name of the header, query or cookie parameter to be used. (Applies to: apiKey)

---

openIdConnectUrl?

optional openIdConnectUrl: string

Defined in: src/types/openapi.ts:1189

REQUIRED. Well-known URL to discover the OpenID Connect provider metadata. (Applies to: openIdConnect)

---

scheme?

optional scheme: string

Defined in: src/types/openapi.ts:1170

REQUIRED. The name of the HTTP Authentication scheme to be used in the Authorization header as defined in RFC7235. The values used SHOULD be registered in the IANA Authentication Scheme registry. The value is case-insensitive, as defined in RFC7235. (Applies to: http)

---

type

type: "apiKey" | "http" | "mutualTLS" | "oauth2" | "openIdConnect"

Defined in: src/types/openapi.ts:1145

REQUIRED. The type of the security scheme. Valid values are "apiKey", "http", "mutualTLS", "oauth2", "openIdConnect".