Package com.atlassian.oauth2.client.api

Interface ClientConfiguration

All Known Implementing Classes:
ClientConfigurationEntity
public interface ClientConfiguration
Configuration for the OAuth 2 flow providing details on the provider and required values in order to complete the flow.

  • Method Details

    • getGrantType

      @Nonnull GrantType getGrantType()
      Returns the grant type for the OAuth 2 flow. Defaults to GrantType.AUTHORIZATION_CODE_GRANT.
      Returns:
      the grant type

    • getProviderType

      @Nonnull ProviderType getProviderType()

    • getClientId

      @Nonnull String getClientId()

    • getClientSecret

      @Nonnull String getClientSecret()
      Returns:
      the client secret. Will be an empty string if the client certificate is used instead

    • getClientCertificate

      Optional<String> getClientCertificate()
      JSON client certificate for authentication. For now only Google Client Credentials is supported
      Returns:
      the base 64 encoded certificate

    • getAuthorizationEndpoint

      @Nonnull String getAuthorizationEndpoint()
      Returns the authorization endpoint url for the OAuth 2 flow.
      Returns:
      the authorization endpoint url or empty string when grant type does not require authorization.
      See Also:

    • getTokenEndpoint

      @Nonnull String getTokenEndpoint()

    • getScopes

      @Nonnull List<String> getScopes()

    • getCustomParams

      @Nonnull Map<String,List<String>> getCustomParams()
      Returns:
      custom parameters to be sent to the authorization server
      Since:
      4.1.0