Package com.atlassian.oauth2.provider.api.client

Interface ClientService

public interface ClientService
Service for managing OAuth2 clients (from the provider's perspective).

When imported via OSGi, System Admin permission checks are enforced on all method calls.

  • Method Details

    • create

      @Deprecated @Nonnull Client create(@Nonnull String name, Scope scope, @Nonnull List<String> redirectUris)
      Deprecated.
      Creates a Client
      Parameters:
      name - the name of the client
      scope - optional scope for client. If not specified then this will be saved as ALL
      redirectUris - the redirect uris of the client
      Returns:
      the newly created entity

    • create

      @Nonnull Client create(CreateClientEntity client)

    • updateClient

      @Deprecated Optional<Client> updateClient(@Nonnull String id, String name, String scope, @Nonnull List<String> redirectUris)
      Deprecated.
      Updates an existing Client
      Parameters:
      id - the id of the entity to update
      name - the new name. Null means no update will occur
      redirectUris - the new redirectUri name

    • updateClient

      Optional<Client> updateClient(UpdateClientEntity client)

    • resetClientSecret

      Optional<Client> resetClientSecret(@Nonnull String clientId)

    • rotateClient

      Optional<Client> rotateClient(@Nonnull String clientId)
      Rotate the client id and secret for the given client id.
      Parameters:
      clientId - the client id to rotate
      Returns:
      the new client id and secret
      Since:
      5.0.0

    • getById

      Optional<Client> getById(@Nonnull String id)
      Gets an existing Client
      Parameters:
      id - of the entity to return
      Returns:
      The Client matching the id or null

    • getByClientId

      Optional<Client> getByClientId(@Nonnull String clientId)
      Gets an existing Client
      Parameters:
      clientId - of the entity to return
      Returns:
      The Client matching the id or null

    • getByRotatedClientId

      Optional<Client> getByRotatedClientId(@Nonnull String clientId)
      Gets an existing Client by rotated client id
      Parameters:
      clientId - of the entity to return
      Returns:
      The Client matching the id or null

    • findRedirectUrisByClientId

      List<String> findRedirectUrisByClientId(@Nonnull String clientId)
      Gets an existing redirect uri
      Parameters:
      clientId - matching the entity to return
      Returns:
      The redirect uri matching the id or empty

    • list

      List<Client> list()
      Gets all Client
      Returns:
      the clients stored in the system

    • removeById

      Optional<Client> removeById(@Nonnull String id)
      Deletes a Client
      Parameters:
      id - of the entity to delete

    • isClientNameUnique

      boolean isClientNameUnique(@Nullable String clientId, @Nonnull String clientName)
      Checks if client name is unique
      Parameters:
      clientId - id of the client
      clientName - name of the client
      Returns:
      true if client name is unique

    • isClientValid

      boolean isClientValid(@Nonnull String clientId, @Nonnull String clientSecret, @Nonnull FlowType flowType)
      Checks if the client is valid for the given flow type
      Parameters:
      clientId - id of the client
      clientSecret - secret of the client
      flowType - the flow type of the client that will determine if a client secret is required
      Returns:
      true if the client is valid for the given flow type
      Since:
      5.0.0

    • isClientSecretValid

      boolean isClientSecretValid(@Nonnull String clientId, @Nonnull String clientSecret)
      Checks if the provided client secret is a match for the client secret stored against the client ID provided
      Parameters:
      clientId - id of the client
      clientSecret - secret of the client
      Returns:
      true if provided client secret is a match

    • isClientSecretValid

      default boolean isClientSecretValid(@Nonnull String clientId, @Nullable String clientSecret, @Nonnull FlowType flowType)
      Checks if the provided client secret is a match for the client secret stored against the client ID provided. If the flow type is a public flow then this will always be true
      Parameters:
      clientId - id of the client
      clientSecret - secret of the client. Can be null if it is a public flow
      flowType - the flow type of the client that will determine if a client secret is required
      Returns:
      true if provided client secret is a match or the secret is not required
      Since:
      3.1.14

    • revokeRotatedClientSecret

      Optional<Client> revokeRotatedClientSecret(@Nonnull String id)
      Revokes the client secret and id for the rotated client, by removing the values. This is used to remove the old client id and secret pair.
      Parameters:
      id - used to identify the client which should have the rotated pair revoked.
      Returns:
      The Optional of the Client matching the id, or, if the id not found it will return Optional.empty()
      Since:
      5.0.0