@Target(value={METHOD,TYPE}) @Retention(value=RUNTIME) @Repeatable(value=SecuritySchemes.class) @Inherited public @interface SecurityScheme
Modifier and Type | Optional Element and Description |
---|---|
java.lang.String |
apiKeyName
Applies to and is REQUIRED for SecurityScheme of apiKey type.
|
java.lang.String |
bearerFormat
Applies to http ("bearer") type.
|
java.lang.String |
description
A short description for security scheme.
|
Extension[] |
extensions
List of extensions to be added to the
SecurityScheme model corresponding to the containing annotation. |
OAuthFlows |
flows
Applies to and is REQUIRED for SecurityScheme of oauth2 type.
|
SecuritySchemeIn |
in
Applies to and is REQUIRED for SecurityScheme of apiKey type.
|
java.lang.String |
openIdConnectUrl
Applies to and is REQUIRED for SecurityScheme of openIdConnect type.
|
java.lang.String |
ref
Reference value to a SecurityScheme object.
|
java.lang.String |
scheme
Applies to and is REQUIRED for SecurityScheme of http type.
|
java.lang.String |
securitySchemeName
The name of this SecurityScheme.
|
SecuritySchemeType |
type
The type of the security scheme.
|
public abstract java.lang.String securitySchemeName
It is a REQUIRED property unless this is only a reference to a security scheme instance.
public abstract SecuritySchemeType type
Type is a REQUIRED property unless this is only a reference to a SecuirtyScheme instance.
public abstract java.lang.String description
public abstract java.lang.String apiKeyName
The name of the header, query or cookie parameter to be used.
public abstract SecuritySchemeIn in
The location of the API key. Valid values are defined by SecuritySchemeIn enum. Ignored when empty string.
public abstract java.lang.String scheme
The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC 7235.
public abstract java.lang.String 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.
public abstract OAuthFlows flows
An object containing configuration information for the flow types supported.
public abstract java.lang.String openIdConnectUrl
OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.
public abstract java.lang.String ref
This property provides a reference to an object defined elsewhere. This property and all other properties are mutually exclusive. If other properties are defined in addition to the ref property then the result is undefined.
public abstract Extension[] extensions
SecurityScheme
model corresponding to the containing annotation.