cec8e5c6f6
This pr is auto merged as it contains a mandatory file and is opened for more than 10 days. |
||
---|---|---|
common | ||
config/checkstyle | ||
core | ||
providers | ||
sample | ||
storage | ||
.gitattributes | ||
.gitignore | ||
.travis.yml | ||
LICENSE.txt | ||
README.md | ||
SECURITY.md | ||
ThirdPartyNotices.txt | ||
pom.xml | ||
settings.xml |
README.md
Visual Studio Team Services Authentication Library for Java (Preview)
Retrieve OAuth2 Access Token or Personal Accesss Tokens for Visual Studio Team Services (visualstudio.com) accounts. Also provides secure storage for those secrets on different platforms.
To learn more about Visual Studio Team Services and our Java specific tools, please visit https://java.visualstudio.com.
What this library provides
This library provides:
- a set of
authenticators
in thecore
module that can be used to retrieve credentials in the form of OAuth2 Access Token or Personal Access Token against any Visual Studio Team Services account. - a set of secure
storage
providers that store retrieved secrets, as well as In memory and File system backed insecure storages. - a set of
providers
that hide the interaction betweenstorage
andauthenticator
, and returns authenticatedclient
that can be used directly against Visual Studio Team Services REST APIs.
Available Secure Storage Providers:
Secret Type | Windows (Credential Manager) | Linux (GNOME Keyring v2.22+) | Mac OSX (Keychain) |
---|---|---|---|
Username / Password Combo (Credential ) |
Yes | Yes | Yes |
OAuth2 Access/Refresh Token (TokenPair ) |
Yes (On Windows 7, 8/8.1 and 10) | Yes | Yes |
VSTS Personal Access Token (Token ) |
Yes | Yes | Yes |
How to use this library
Maven is the preferred way to referencing this library.
<dependency>
<groupId>com.microsoft.alm</groupId>
<artifactId>auth-providers</artifactId>
<version>0.6.4</version>
</dependency>
If only interested in specific modules:
<dependency>
<groupId>com.microsoft.alm</groupId>
<artifactId>auth-secure-storage</artifactId>
<version>0.6.4</version>
</dependency>
<dependency>
<groupId>com.microsoft.alm</groupId>
<artifactId>auth-core</artifactId>
<version>0.6.4</version>
</dependency>
Here is a Sample App that uses this library.
How to build
- Oracle JDK 6
- Maven 3.2+
mvn clean verify
How can I contribute?
This is a preview release, please open issues and give us feedback! We also welcome Pull Requests.
License
The MIT license can be found in LICENSE.txt
Code of Conduct
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.