com.ibm.broker.rest

Interface OAuth2SecurityScheme

  • All Superinterfaces:
    SecurityScheme


    public interface OAuth2SecurityScheme
    extends SecurityScheme
    An interface that describes an OAuth2 security scheme in an API. A OAuth2 security scheme negotiates with a authorization and/or token URL to acquire tokens that can be used in requests to the API.
    Since:
    IBM Integration Bus v10.0.0.6
    • Method Detail

      • getFlow

        OAuth2Flow getFlow()
        Get the OAuth2 flow in use by this security scheme.
        Returns:
        the OAuth2 flow in use by this security scheme.
      • getAuthorizationURL

        java.lang.String getAuthorizationURL()
        Get the URL of the authorization endpoint to be used by the specified OAuth2 flow.
        Returns:
        the URL of the authorization endpoint, or null if not required by this OAuth2 flow.
      • getTokenURL

        java.lang.String getTokenURL()
        Get the URL of the token endpoint to be used by the specified OAuth2 flow.
        Returns:
        the URL of the token endpoint, or null if not required by this OAuth2 flow.
      • getScopes

        java.util.Map<java.lang.String,java.lang.String> getScopes()
        Get a mapping of available OAuth2 scopes. The mapping is a map between OAuth2 scope and a short description.
        Returns:
        a mapping of available OAuth2 scopes.