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

Interface InternalRotationClientService

public interface InternalRotationClientService
An internal service for managing Oauth2 clients Used for background job in applinks to rotate client secrets without user context.

  • Method Details

    • create

      @Nonnull Client create(CreateClientEntity client)
      Creates a Client
      Parameters:
      client - the entity object for the client to create
      Returns:
      the newly created entity

    • 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

    • removeById

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

    • 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