-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
31 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# Token-based Authentication Providers for Redis Java clients | ||
|
||
This extension provides Token-based Authentication for Redis Java client libraries([lettuce](https://github.com/redis/lettuce) and [Jedis](https://github.com/redis/jedis)) to support token-based authentication. | ||
|
||
## Microsoft Entra ID provider | ||
|
||
### Installation | ||
To install the Java packages, add the following dependencies to your `pom.xml` file if you're using Maven: | ||
```xml | ||
<dependency> | ||
<groupId>redis.clients.authentication</groupId> | ||
<artifactId>redis-authx-entraid</artifactId> | ||
<version>0.1.1-beta1</version> | ||
</dependency> | ||
``` | ||
If you're using Gradle, add the following dependencies to your `build.gradle` file: | ||
|
||
``` | ||
implementation 'redis.clients.authentication:redis-authx-entraid:0.1.1-beta1' | ||
``` | ||
|
||
### Quick Start | ||
Basic usage would look like this: | ||
```java | ||
TokenAuthConfig tokenAuthConfig = EntraIDTokenAuthConfigBuilder.builder() | ||
.clientId("YOUR_CLIENT_ID").secret("YOUR_SECRET") | ||
.authority("YOUR_AUTHORITY").scopes("SCOPES").build(); | ||
``` | ||
With the `tokenAuthConfig` provided, both Jedis and Lettuce clients can automatically handle Reauthentication with EntraID. | ||
|
||
Refer to the [test files](https://github.com/redis/tbd-auth-entraid/tree/main/entraid/src/test/java/redis/clients/authentication) for more examples and detailed usage. |