io.swagger.v3.oas.annotations.security

Annotation Type SecurityRequirement

@Target(value={METHOD,TYPE,ANNOTATION_TYPE})
 @Retention(value=RUNTIME)
 @Repeatable(value=SecurityRequirements.class)
 @Inherited
public @interface SecurityRequirement

The annotation may be applied at class or method level, or in Operation.security() ()} to define security requirements for the single operation (when applied at method level) or for all operations of a class (when applied at class level).

It can also be used in OpenAPIDefinition.security() to define spec level security.

See Also:

Security Requirement (OpenAPI specification), OpenAPIDefinition, Operation

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name This name must correspond to a declared SecurityRequirement.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	scopes If the security scheme is of type "oauth2" or "openIdConnect", then the value is a list of scope names required for the execution.

Element Detail

name

public abstract String name

This name must correspond to a declared SecurityRequirement.

Returns:

String name

scopes

public abstract String[] scopes

If the security scheme is of type "oauth2" or "openIdConnect", then the value is a list of scope names required for the execution. For other security scheme types, the array must be empty.

Returns:

String array of scopes

Default:

{}