Skip to content

get-security-schemes

Tool name: get-security-schemes

Get the security schemes for a specific API

Input schema

namestring, non-empty
API name, or a unique part of it. Omit when `filePath` is given.
versionstring
API version. When omitted and several versions exist, the highest one is used.
filePathstring
Path to the API description file.
Input example
{
  "name": "string",
  "version": "string",
  "filePath": "string"
}

Output schema

namestringrequired
API title.
versionstringrequired
API version.
filePathstringrequired
API description file path for this result.
otherMatchesArray of objects(ApiDescriptionRef)
Other description files the lookup matched. Present only when several share the requested name.
securitySchemesobjectrequired
Security schemes map from the OpenAPI components section.
securityArray of objectsrequired
Global security requirements defined on the OpenAPI document.
Output example
{}