Package org.springframework.vault.authentication

Class GitHubAuthentication

java.lang.Object

org.springframework.vault.authentication.GitHubAuthentication

All Implemented Interfaces:

AuthenticationStepsFactory, ClientAuthentication

public class GitHubAuthentication
extends Object
implements ClientAuthentication, AuthenticationStepsFactory

GitHub's authentication method can be used to authenticate with Vault using a GitHub personal access token.

Since:

3.2

Author:

Nanne Baars, Mark Paluch

See Also:

• GitHubAuthentication
• RestOperations
• GitHub Auth Backend

Constructor Summary

Constructors

Constructor	Description
GitHubAuthentication(GitHubAuthenticationOptions options, RestClient client)	Create a GitHubAuthentication using GitHubAuthenticationOptions and RestOperations.
GitHubAuthentication(GitHubAuthenticationOptions options, RestOperations restOperations)	Create a GitHubAuthentication using GitHubAuthenticationOptions and RestOperations.

Method Summary

Modifier and Type	Method	Description
static AuthenticationSteps	createAuthenticationSteps(GitHubAuthenticationOptions options)	Creates a AuthenticationSteps for GitHub authentication given GitHubAuthenticationOptions.
AuthenticationSteps	getAuthenticationSteps()	Get the AuthenticationSteps describing an authentication flow.
VaultToken	login()	Return a VaultToken.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GitHubAuthentication

public GitHubAuthentication(GitHubAuthenticationOptions options,
 RestOperations restOperations)

Create a GitHubAuthentication using GitHubAuthenticationOptions and RestOperations.

Parameters:

options - must not be null.

restOperations - must not be null.

GitHubAuthentication

public GitHubAuthentication(GitHubAuthenticationOptions options,
 RestClient client)

Create a GitHubAuthentication using GitHubAuthenticationOptions and RestOperations.

Parameters:

options - must not be null.

client - must not be null.

Since:

4.0

Method Details

createAuthenticationSteps

public static AuthenticationSteps createAuthenticationSteps(GitHubAuthenticationOptions options)

Creates a AuthenticationSteps for GitHub authentication given GitHubAuthenticationOptions.

Parameters:

options - must not be null.

Returns:

AuthenticationSteps for github authentication.

getAuthenticationSteps

public AuthenticationSteps getAuthenticationSteps()

Description copied from interface: AuthenticationStepsFactory

Get the AuthenticationSteps describing an authentication flow.

Specified by:

getAuthenticationSteps in interface AuthenticationStepsFactory

Returns:

the AuthenticationSteps describing an authentication flow.

login

public VaultToken login()
                 throws VaultException

Description copied from interface: ClientAuthentication

Return a VaultToken. This method can optionally log into Vault to obtain a token.

Specified by:

login in interface ClientAuthentication

Returns:

a VaultToken.

Throws:

VaultException