#[derive(SecurityScheme)]
{
// Attributes available to this derive:
#[oai]
}
Expand description
Define a OpenAPI Security Scheme.
| Attribute | description | Type | Optional |
|---|
| rename | Rename the security scheme. | string | Y |
| type | The type of the security scheme. (api_key, basic, bearer, oauth2, openid_connect) | string | N |
| in | api_key The location of the API key. Valid values are “query”, “header” or “cookie”. (query, header, cookie) | string | Y |
| key_name | api_key The name of the header, query or cookie parameter to be used.. | string | Y |
| bearer_format | bearer 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. | string | Y |
| flows | oauth2 An object containing configuration information for the flow types supported. | OAuthFlows | Y |
| openid_connect_url | OpenId Connect URL to discover OAuth2 configuration values. | string | Y |
| Attribute | description | Type | Optional |
|---|
| implicit | Configuration for the OAuth Implicit flow | OAuthFlow | Y |
| password | Configuration for the OAuth Resource Owner Password flow | OAuthFlow | Y |
| client_credentials | Configuration for the OAuth Client Credentials flow | OAuthFlow | Y |
| authorization_code | Configuration for the OAuth Authorization Code flow | OAuthFlow | Y |
| Attribute | description | Type | Optional |
|---|
| authorization_url | implicit authorization_code The authorization URL to be used for this flow. | string | Y |
| token_url | password client_credentials authorization_code The token URL to be used for this flow. | string | Y |
| refresh_url | The URL to be used for obtaining refresh tokens. | string | Y |
| scopes | The available scopes for the OAuth2 security scheme. | OAuthScopes | Y |