com.veeva.vault.vapil.api.request

Class AuthenticationRequest

java.lang.Object

com.veeva.vault.vapil.api.request.VaultRequest

com.veeva.vault.vapil.api.request.AuthenticationRequest

public class AuthenticationRequest
extends VaultRequest

Authenticate to Vault using standard username/password, OAuth, or Salesforce delegated authentication. Successful connections return an AuthenticationResponse, which stores the Vault session ID.

Note that the VaultClient automatically performs Authentication requests to establish the Vault session.

Vault API Coverage:

https://developer.veevavault.com/api/21.1/#authentication

Field Summary

Fields inherited from class com.veeva.vault.vapil.api.request.VaultRequest

HTTP_HEADER_AUTHORIZATION, HTTP_HEADER_VAULT_CLIENT_ID, vaultClient

Method Summary

Modifier and Type	Method and Description
DiscoveryResponse	authenticationTypeDiscovery(String username) Authenticate via standard Vault user name and password in the user's default Vault.
AuthenticationResponse	login(String userName, String userPassword) Authenticate via standard Vault user name and password in the user's default Vault.
AuthenticationResponse	login(String username, String password, String vaultDNS) Authenticate via standard Vault user name and password in a specific Vault Domain.
AuthenticationResponse	loginOAuth(String oauthOidcProfileId, String accessToken, String vaultDNS) Authenticate your account using OAuth 2.0 / Open ID Connect token to obtain a Vault session ID.
AuthenticationResponse	loginWithDiscovery(String vaultUserName, String password, String vaultDNS) Authenticate using Vault Discovery endpoints.
ApiVersionResponse	retrieveApiVersions() Retrieves api versions supported by the current Vault
AuthenticationRequest	setIdpUserName(String idpUserName)
AuthenticationRequest	setValidateDNS(Boolean validateDNS) Validate Vault DNS after successful login
AuthenticationRequest	setVaultOAuthClientId(String vaultOAuthClientId) Set the Header Accept to return CSV
UserRetrieveResponse	validateSessionUser() Validate Session User

Methods inherited from class com.veeva.vault.vapil.api.request.VaultRequest

getBaseObjectMapper, send, send, sendReturnBinary, sendReturnBinary, sendToFile, sendToFile, setVaultClient

Methods inherited from class java.lang.Object

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

Method Detail

retrieveApiVersions

public ApiVersionResponse retrieveApiVersions()

Retrieves api versions supported by the current Vault

Returns:

ApiVersionResponse

Vault API Endpoint:

 GET /api

Vault API Help Link:

(Undocumented Endpoint)

login

public AuthenticationResponse login(String userName,
                                    String userPassword)

Authenticate via standard Vault user name and password in the user's default Vault.

Parameters:

userName - The user name for authentication

userPassword - The user password

Returns:

AuthenticationResponse

Vault API Endpoint:

 GET /api/{version}/auth

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#user-name-and-password

login

public AuthenticationResponse login(String username,
                                    String password,
                                    String vaultDNS)

Authenticate via standard Vault user name and password in a specific Vault Domain.

Parameters:

username - The user name for authentication

password - The user password

vaultDNS - The DNS of the vault for which you want to generate a session

Returns:

AuthenticationResponse

Vault API Endpoint:

 GET /api/{version}/auth

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#user-name-and-password

loginOAuth

public AuthenticationResponse loginOAuth(String oauthOidcProfileId,
                                         String accessToken,
                                         String vaultDNS)

Authenticate your account using OAuth 2.0 / Open ID Connect token to obtain a Vault session ID. Learn more about OAuth 2.0 / Open ID Connect in Vault Help.

When requesting a sessionId, Vault allows the ability for Oauth2/OIDC client applications to pass the client_id with the request. Vault uses this client_id when talking with the introspection endpoint at the authorization server to validate that the access_token presented by the application is valid. Learn more about Client ID in the REST API Documentation.

Parameters:

oauthOidcProfileId - The ID of your OAuth2.0 / Open ID Connect profile.

accessToken - OAuth Access Token (access_token)

vaultDNS - The DNS of the vault for which you want to generate a session

Returns:

AuthenticationResponse

Vault API Endpoint:

 POST login.veevavault.com/auth/oauth/session/{oath_oidc_profile_id}

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#oauth-2-0-openid-connect

loginWithDiscovery

public AuthenticationResponse loginWithDiscovery(String vaultUserName,
                                                 String password,
                                                 String vaultDNS)

Authenticate using Vault Discovery endpoints. First Vault is queried for the user's authentication method, and if SSO, this method attempts to acquire an OAuth token. If the user is basic username/password, the simple login method is used.

Parameters:

vaultUserName - The user name for authentication

password - The user password

vaultDNS - The DNS of the vault for which you want to generate a session

Returns:

AuthenticationResponse

authenticationTypeDiscovery

public DiscoveryResponse authenticationTypeDiscovery(String username)

Authenticate via standard Vault user name and password in the user's default Vault.

Parameters:

username - The user name for authentication

Returns:

AuthenticationResponse

Vault API Endpoint:

 GET login.veevavault.com/auth/discovery

validateSessionUser

public UserRetrieveResponse validateSessionUser()

Validate Session User

Given a valid session ID, this request returns information for the currently authenticated user. If the session ID is not valid, this request returns an INVALID_SESSION_ID error type. This is similar to a whoami request.

Returns:

UserRetrieveResponse Vault returns an array of size 1

Vault API Endpoint:

 GET /api/{version}/objects/users/me

Vault API Help Link:

https://developer.veevavault.com/api/21.1/#validate-session-user

Example Request:

 UserRetrieveResponse resp = vaultClient.newRequest(AuthenticationRequest.class).validateSessionUser();

Example Response:

 for(UserRetrieveResponse.UserNode userNode : resp.getUsers()) {
   User user = userNode.getUser();
   System.out.println("User name: " + user.getUserName());
   System.out.println("User: " + user.getUserFirstName() + " " + user.getUserLastName());
   System.out.println("Email: " + user.getUserEmail());
   System.out.println("Id: " + user.getId());
 }

setVaultOAuthClientId

public AuthenticationRequest setVaultOAuthClientId(String vaultOAuthClientId)

Set the Header Accept to return CSV

Parameters:

vaultOAuthClientId - Client Id for the Vault App

Returns:

The Request

setIdpUserName

public AuthenticationRequest setIdpUserName(String idpUserName)

setValidateDNS

public AuthenticationRequest setValidateDNS(Boolean validateDNS)

Validate Vault DNS after successful login

Parameters:

validateDNS - true/false

Returns:

The request