RestApiSecurityScheme Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
REST API Security Scheme.
public sealed class RestApiSecuritySchemetype RestApiSecurityScheme = classPublic NotInheritable Class RestApiSecurityScheme- Inheritance
-
RestApiSecurityScheme
Properties
| BearerFormat |
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. |
| Description |
A short description for security scheme. CommonMark syntax MAY be used for rich text representation. |
| Flows |
REQUIRED. An object containing configuration information for the flow types supported. |
| In |
REQUIRED. The location of the API key. Valid values are "query", "header" or "cookie". |
| Name |
REQUIRED. The name of the header, query or cookie parameter to be used. |
| OpenIdConnectUrl |
REQUIRED. OpenId Connect URL to discover OAuth2 configuration values. |
| Scheme |
REQUIRED. The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235. |
| SecuritySchemeType |
REQUIRED. The type of the security scheme. Valid values are "apiKey", "http", "oauth2", "openIdConnect". |