Annotation Type SecurityRequirement

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      SecurityRequirementEntry[] combine
      If multiple requirements apply at the same time, use this value instead of name() and scopes().
      String name
      This name must correspond to a declared SecurityRequirement.
      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

        String name
        This name must correspond to a declared SecurityRequirement.

        Exactly one of this and combine() must be set.

        Returns:
        String name
        Default:
        ""
      • scopes

        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:
        {}
      • combine

        SecurityRequirementEntry[] combine
        If multiple requirements apply at the same time, use this value instead of name() and scopes(). If any one of multiple security schemes is required, use multiple SecurityRequirement annotations instead.

        Exactly one of this and name() must be set.

        Returns:
        SecurityRequirementEntry array of requirements
        Default:
        {}