Package com.atlassian.sal.api.auth

Interface LoginUriProvider

public interface LoginUriProvider
Provides the URI to redirect users to for them to login before they can authorize consumer requests to access their data.
Since:
2.0

  • Method Details

    • getLoginUri

      URI getLoginUri(URI returnUri)
      Returns the URI to redirect users for login. It must append the returnUri so that once login is complete, the user will be redirected back to the original page.
      Parameters:
      returnUri - URI of the page the application should redirect the user to after login is complete
      Returns:
      the URI to redirect users for login
      Throws:
      RuntimeException - if the returnUri is not a valid URI, or cannot be url encoded properly

    • getLoginUri

      URI getLoginUri(URI returnUri, EnumSet<PageCapability> pageCaps)
      Returns the URI to redirect users for login. It must append the returnUri so that once login is complete, the user will be redirected back to the original page.
      Parameters:
      returnUri - URI of the page the application should redirect the user to after login is complete
      pageCaps - PageCapability for product to supply in login page.
      Returns:
      the URI to redirect users for login
      Throws:
      RuntimeException - if the returnUri is not a valid URI, or cannot be url encoded properly

    • getLoginUriForRole

      URI getLoginUriForRole(URI returnUri, UserRole role)
      Returns the URI to redirect users for login. It must append the returnUri so that once login is complete, the user will be redirected back to the original page. Page is expected to redirect back to URI only if u
      Parameters:
      returnUri - URI of the page the application should redirect the user to after login is complete
      role - UserRole of user
      Returns:
      the URI to redirect users for login
      Throws:
      RuntimeException - if the returnUri is not a valid URI, or cannot be url encoded properly

    • getLoginUriForRole

      URI getLoginUriForRole(URI returnUri, UserRole role, EnumSet<PageCapability> pageCaps)
      Returns the URI to redirect users for login. It must append the returnUri so that once login is complete, the user will be redirected back to the original page. Page is expected to redirect back to URI only if u This page is supposed to match requested PageCapability
      Parameters:
      returnUri - URI of the page the application should redirect the user to after login is complete
      role - UserRole of user
      pageCaps - PageCapability for product to supply in login page.
      Returns:
      the URI to redirect users for login
      Throws:
      RuntimeException - if the returnUri is not a valid URI, or cannot be url encoded properly