Package io.swagger.annotations

Annotation Type OAuth2Definition

  • public @interface OAuth2Definition
    Annotation used to construct OAuth security definition.

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      OAuth2Definition.Flow flow
      The flow used by the OAuth2 security scheme.
      String key
      Key used to refer to this security definition

    • Element Detail

      • key

        String key
        Key used to refer to this security definition
        Returns:
        key used to refer to this security definition

      • flow

        OAuth2Definition.Flow flow
        The flow used by the OAuth2 security scheme. Valid values are "implicit", "password", "application" or "accessCode".
        Returns:

      • description

        String description
        A short description for security scheme.
        Returns:
        a short description for security scheme.
        Default:
        ""

      • authorizationUrl

        String authorizationUrl
        The authorization URL to be used for this flow. This SHOULD be in the form of a URL. Required for implicit and access code flows
        Returns:
        the authorization URL to be used for this flow. This SHOULD be in the form of a URL.
        Default:
        ""

      • tokenUrl

        String tokenUrl
        The token URL to be used for this flow. This SHOULD be in the form of a URL. Required for password, applcation, and access code flows.
        Returns:
        the token URL to be used for this flow. This SHOULD be in the form of a URL.
        Default:
        ""

      • scopes

        Scope[] scopes
        Default:
        {}