Purpose

Determines which authentication method the driver uses during the course of a session.

Valid Values

None | AWS | Basic | BearerToken | OAuth2 | OAuth2-AccessToken | OAuth2-AuthorizationCode | OAuth2-PKCE | OAuth2-Password | OAuth2-ClientCredentials | OAuth2-RefreshToken | OAuth2-JWTBearer | HTTPHeader | URLParameter | Digest | Custom

Behavior

If set to None, the driver does not attempt to authenticate.

If set to AWS, the driver uses AWS (Amazon Web Services) credentials for authentication. You must also configure the AccessKey, Region, and SecretKey properties.

If set to Basic, the driver uses a hashed value, based on the concatenation of the user name and password, for authentication. In addition to the User and Password properties, you must also configure the AuthHeader property if the name of your HTTP header is not Authorization (the default).

If set to BearerToken, the driver uses an API Token, configured as BearerToken, for authentication. The BearerToken is specified via the SecurityToken property.

If set to OAuth2, the driver uses OAuth 2.0 to authenticate to REST endpoints. This is a legacy value that allows you to connect to all supported grant flows. When this value is set, the driver determines which grant type to use based on the OAuth 2.0 related properties you specify. This setting differs from other OAuth 2.0 values in that, when specified, it exposes all OAuth 2.0 related properties on the Configuration Manager, instead of only those related to a specified grant type. See "OAuth 2.0 authentication" for details.

If set to OAuth2-AccessToken, the driver uses the access token authentication flow to authenticate to REST endpoints. See "OAuth 2.0 authentication" for details.

If set to OAuth2-AuthorizationCode, the driver uses authorization code grant to authenticate to REST endpoints. When EnableLoginPrompt=true, the driver uses dynamic authorization flow.

If set to OAuth2-PKCE, the driver uses the PKCE grant to authenticate to REST endpoints. See "OAuth 2.0 authentication" for details.

If set to OAuth2-Password, the driver uses the password grant authentication to authenticate to REST endpoints. See "OAuth 2.0 authentication" for details.

If set to OAuth2-ClientCredentials, the driver uses the client credentials grant to authenticate to REST endpoints. See "OAuth 2.0 authentication" for details.

If set to OAuth2-RefreshToken, the driver uses the refresh token grant to authenticate to REST endpoints. See "OAuth 2.0 authentication" for details.

If set to OAuth2-JWTBearer, the driver uses the JWT bearer token grant to authenticate to REST endpoints. See "OAuth 2.0 authentication" for details.

If set to HttpHeader, the driver passes security tokens via HTTP headers for authentication. You must also configure SecurityToken property and, if the name of your HTTP header is not Authorization (the default), the AuthHeader property.

If set to URLParameter, the driver passes security tokens via the URL for authentication. You must also configure the AuthParam and SecurityToken properties.

If set to Digest, the driver uses digest access authentication to negotiate username and password authentication. You must also configure the User and Password properties.

If set to Custom, the driver uses custom authentication requests specified in the REST config file to login to server and generate the credentials needed to authenticate data requests.

Data Source Methods

public String getAuthenticationMethod()

public void setAuthenticationMethod(String)

Default Value

None

Data Type

String