Security Requirementオブジェクト

この操作を実行するために必要なセキュリティ スキームをリストします。各プロパティに使用される名前は、コンポーネント オブジェクトのセキュリティ スキームで宣言されたセキュリティ スキームに対応する必要があります。

セキュリティ要件 複数のスキームを含むオブジェクトでは、リクエストが承認されるためにはすべてのスキームが満たされる必要があります。これにより、セキュリティ情報を伝達するために複数のクエリ パラメーターまたは HTTP ヘッダーが必要なシナリオのサポートが可能になります。

セキュリティ要件オブジェクトのリストがOpenAPI オブジェクトまたは操作オブジェクトで定義されている場合、リクエストを承認するにはリスト内のセキュリティ要件オブジェクトの 1 つだけを満たす必要があります。

パターン化されたフィールド

フィールドパターン	タイプ	説明
{名前}	[ string]	それぞれの名前は、コンポーネント オブジェクトの下のセキュリティ スキームで宣言されているセキュリティ スキームに対応していなければなりません。セキュリティスキームのタイプが"oauth2"または "openIdConnect"の場合、値は実行に必要なスコープ名のリストであり、認可に指定されたスコープが必要ない場合、リストは空であってもよい(MAY)。他のセキュリティ スキーム タイプの場合、配列には、実行に必要なロール名のリストが含まれていてもよいが、それ以外の場合には定義または帯域内で交換されません。

セキュリティ要件オブジェクトの例

非OAuth2セキュリティ要件

{  "api_key": []}


api_key: []

OAuth2 セキュリティ要件

{  "petstore_auth": [    "write:pets",    "read:pets"  ]}


petstore_auth:- write:pets- read:pets

オプションのOAuth2セキュリティ

OpenAPI オブジェクトまたは操作オブジェクトで定義されるオプションの OAuth2 セキュリティ:

{  "security": [    {},    {      "petstore_auth": [        "write:pets",        "read:pets"      ]    }  ]}


security:  - {}  - petstore_auth:    - write:pets    - read:pets