io.swagger.oas.annotations.security

Annotation Type SecurityScheme

@Target(value={METHOD,TYPE})
 @Retention(value=RUNTIME)
 @Inherited
public @interface SecurityScheme

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name Required.
String	type Required.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	bearerFormat A hint to the client to identify how the bearer token is formatted.
String	description A short description for security scheme.
OAuthFlows	flows Required.
String	in Required.
String	openIdConnectUrl Required.
String	scheme Required.

Element Detail

type

public abstract String type

Required. The type of the security scheme. Valid values are "apiKey", "http", "oauth2", "openIdConnect".

name

public abstract String name

Required. The name of the header or query parameter to be used.

description

public abstract String description

A short description for security scheme. CommonMark syntax can be used for rich text representation.

Default:

""

in

public abstract String in

Required. The location of the API key. Valid values are "query" or "header".

Default:

""

scheme

public abstract String scheme

Required. The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC 7235.

Default:

""

bearerFormat

public abstract 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.

Default:

""

flows

public abstract OAuthFlows flows

Required. An object containing configuration information for the flow types supported.

Default:

@io.swagger.oas.annotations.security.OAuthFlows

openIdConnectUrl

public abstract String openIdConnectUrl

Required. OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.

Default:

""