@loopback/docs/site/apidocs/openapi-spec-builder.componentsspecbuilder.withsecurityscheme.md

Documentation for LoopBack 4

---
lang: en
title: 'API docs: openapi-spec-builder.componentsspecbuilder.withsecurityscheme'
keywords: LoopBack 4.0, LoopBack 4
sidebar: lb4_sidebar
editurl: https://github.com/strongloop/loopback-next/tree/master/packages/openapi-spec-builder
permalink: /doc/en/lb4/apidocs.openapi-spec-builder.componentsspecbuilder.withsecurityscheme.html
---

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@loopback/openapi-spec-builder](./openapi-spec-builder.md) &gt; [ComponentsSpecBuilder](./openapi-spec-builder.componentsspecbuilder.md) &gt; [withSecurityScheme](./openapi-spec-builder.componentsspecbuilder.withsecurityscheme.md)

## ComponentsSpecBuilder.withSecurityScheme() method

Define a component security scheme.

<b>Signature:</b>

```typescript
withSecurityScheme(name: string, securityScheme: SecuritySchemeObject | ReferenceObject): this;
```

## Parameters

|  Parameter | Type | Description |
|  --- | --- | --- |
|  name | <code>string</code> | The name of the security scheme |
|  securityScheme | <code>SecuritySchemeObject &#124; ReferenceObject</code> | Specification of the security scheme |

<b>Returns:</b>

`this`