io.restassured.specification

Interface AuthenticationSpecification

All Known Implementing Classes:

AuthenticationSpecificationImpl

public interface AuthenticationSpecification

Specify an authentication scheme to use when sending a request.

Method Summary

Modifier and Type	Method and Description
RequestSpecification	basic(String userName, String password) Use http basic authentication.
RequestSpecification	certificate(String certURL, String password) Sets a certificate to be used for SSL authentication.
RequestSpecification	certificate(String certURL, String password, CertificateAuthSettings certificateAuthSettings) Sets a certificate to be used for SSL authentication.
RequestSpecification	digest(String userName, String password) Use http digest authentication.
RequestSpecification	form(String userName, String password) Use form authentication.
RequestSpecification	form(String userName, String password, FormAuthConfig config) Use form authentication with the supplied configuration.
RequestSpecification	none() Explicitly state that you don't which to use any authentication in this request.
RequestSpecification	ntlm(String userName, String password, String workstation, String domain) Use NTLM authentication.
RequestSpecification	oauth(String consumerKey, String consumerSecret, String accessToken, String secretToken) Excerpt from the HttpBuilder docs: OAuth sign the request.
RequestSpecification	oauth(String consumerKey, String consumerSecret, String accessToken, String secretToken, OAuthSignature signature) Excerpt from the HttpBuilder docs: OAuth sign the request.
RequestSpecification	oauth2(String accessToken) OAuth2 sign the request.
RequestSpecification	oauth2(String accessToken, OAuthSignature signature) OAuth2 sign the request.
PreemptiveAuthSpec	preemptive() Returns the preemptive authentication view.

Method Detail

basic

RequestSpecification basic(String userName,
                           String password)

Use http basic authentication.

Parameters:

userName - The user name.

password - The password.

Returns:

The Request specification

ntlm

RequestSpecification ntlm(String userName,
                          String password,
                          String workstation,
                          String domain)

Use NTLM authentication.

Parameters:

userName - The user name.

password - The password.

Returns:

The Request specification

digest

RequestSpecification digest(String userName,
                            String password)

Use http digest authentication.

Parameters:

userName - The user name.

password - The password.

Returns:

The Request specification

form

RequestSpecification form(String userName,
                          String password)

Use form authentication. Rest Assured will try to parse the response login page and determine and try find the action, username and password input field automatically.

Parameters:

userName - The user name.

password - The password.

Returns:

The Request specification

form

RequestSpecification form(String userName,
                          String password,
                          FormAuthConfig config)

Use form authentication with the supplied configuration.

Parameters:

userName - The user name.

password - The password.

config - The form authentication config

Returns:

The authentication scheme

certificate

RequestSpecification certificate(String certURL,
                                 String password)

Sets a certificate to be used for SSL authentication. See Class.getResource(String) for how to get a URL from a resource on the classpath.

Uses keystore: KeyStore.getDefaultType().
Uses port: 443
Uses keystore provider: none

Parameters:

certURL - URL to a JKS keystore where the certificate is stored.

password - password to decrypt the keystore

Returns:

The request io.restassured.specification

certificate

RequestSpecification certificate(String certURL,
                                 String password,
                                 CertificateAuthSettings certificateAuthSettings)

Sets a certificate to be used for SSL authentication. See Class.getResource(String) for how to get a URL from a resource on the classpath.

Parameters:

certURL - URL to a JKS keystore where the certificate is stored.

password - The password for the keystore

certificateAuthSettings - More advanced settings for the certificate authentication

oauth2

RequestSpecification oauth2(String accessToken)

OAuth2 sign the request. Note that this currently does not wait for a WWW-Authenticate challenge before sending the the OAuth header (so currently it's the same as preemptive oauth2 authentication. The reason why it's located here is to be backward compatible). This assumes you've already generated an accessToken for the site you're targeting. The access token will be put in a header.

Parameters:

accessToken - The access token

Returns:

The request io.restassured.specification

oauth2

RequestSpecification oauth2(String accessToken,
                            OAuthSignature signature)

OAuth2 sign the request. Note that this currently does not wait for a WWW-Authenticate challenge before sending the the OAuth header. This assumes you've already generated an accessToken for the site you're targeting.

Parameters:

accessToken - The access token

signature - The signature (note that if using OAuthSignature.QUERY_STRING then Scribe must be added to the classpath)

Returns:

The request io.restassured.specification

oauth

RequestSpecification oauth(String consumerKey,
                           String consumerSecret,
                           String accessToken,
                           String secretToken)

Excerpt from the HttpBuilder docs:
OAuth sign the request. Note that this currently does not wait for a WWW-Authenticate challenge before sending the the OAuth header. All requests to all domains will be signed for this instance. This assumes you've already generated an accessToken and secretToken for the site you're targeting. For more information on how to achieve this, see the Scribe documentation.

Parameters:

consumerKey -

consumerSecret -

accessToken -

secretToken -

Returns:

The request io.restassured.specification

oauth

RequestSpecification oauth(String consumerKey,
                           String consumerSecret,
                           String accessToken,
                           String secretToken,
                           OAuthSignature signature)

Excerpt from the HttpBuilder docs:
OAuth sign the request. Note that this currently does not wait for a WWW-Authenticate challenge before sending the the OAuth header. All requests to all domains will be signed for this instance. This assumes you've already generated an accessToken and secretToken for the site you're targeting. For more information on how to achieve this, see the Scribe documentation.

Parameters:

consumerKey -

consumerSecret -

accessToken -

secretToken -

signature -

Returns:

The request io.restassured.specification

preemptive

PreemptiveAuthSpec preemptive()

Returns the preemptive authentication view. This means that the authentication details are sent in the request header regardless if the server has challenged for authentication or not.

Returns:

The preemptive authentication specification.

none

RequestSpecification none()

Explicitly state that you don't which to use any authentication in this request. This is useful only in cases where you've specified a default authentication scheme and you wish to override it for a single request.

Returns:

The Request specification