Module org.mule.sdk.api
Package org.mule.sdk.api.connectivity.oauth

Interface AuthCodeRequest

@NoImplement @MinMuleVersion("4.5.0") public interface AuthCodeRequest
Provides information about the request that is sent to the authorization url during an OAuth2 dance using the Authorization-Code grant type.

If the acting ConnectionProvider has a before flow configured, then an instance of this class will be initial payload of such flow.

Since:
1.0

  • Method Details

    • getResourceOwnerId

      String getResourceOwnerId()
      Returns:
      The id of the user being authenticated

    • getScopes

      Optional<String> getScopes()
      Returns:
      The scopes that were requested

    • getState

      Optional<String> getState()
      Returns:
      The OAuth state that was sent

    • getExternalCallbackUrl

      Optional<String> getExternalCallbackUrl()
      Returns:
      The external callback url that the user configured or Optional.empty() if none was provided