skip to main content
Using the driver : Using connection properties : OAuth 2.0 properties
  

Try DataDirect Drivers Now

OAuth 2.0 properties

The following table summarizes connection properties that are used for OAuth 2.0 authentication. See "OAuth 2.0 authentication" for the properties used for each authentication flow.
Table 11. Authentication Properties
Property
Characteristic
Specifies the access token required to authenticate to a REST service when OAuth 2.0 is enabled (AuthenticationMethod=OAuth2). Typically, this property is configured by the application
Determines which authentication method the driver uses during the course of a session.
If set to None, the driver does not attempt to authenticate.
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 Custom, the driver uses the custom token-based authentication flow that is defined in the input REST file.
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 OAuth2, the driver uses OAuth 2.0 to authenticate to REST endpoints.
If set to UrlParameter, the driver passes security tokens via the URL for authentication. You must also configure the AuthParam and SecurityToken properties.
The default is None.
Specifies the client ID key for your application. The driver uses this value for certain flows when authenticating to a REST service using OAuth 2.0 (AuthenticationMethod=OAuth2).
Specifies the client secret for your application when authenticating to a REST service with OAuth 2.0 enabled (AuthenticationMethod=OAuth2).
Important: The client secret is a confidential value used to authenticate the application to the server. The value must be securely maintained to prevent unauthorized access.
Specifies the endpoint the driver calls to notify the service to log the client out of the session, including performing any clean-up tasks or expiring the token.
Specifies the temporary authorization code that is exchanged for access tokens when OAuth 2.0 authentication is enabled (AuthenticationMethod=OAuth2). Authorization codes are used to authenticate against the endpoint specified by the TokenURI property. If authentication is successful, an access token is generated and fetched from the specified location.
Specifies the password to use to connect to your REST service.
Specifies the endpoint to which the client is returned after authenticating with a third-party service when OAuth 2.0 authentication is enabled (AuthenticationMethod=OAuth2).
Specifies a space-separated list of OAuth scopes that limit the permissions granted by an access token. The driver uses this value when authenticating to a REST service using OAuth 2.0 (AuthenticationMethod=OAuth2).
Specifies the endpoint used to exchange authentication credentials for access tokens when OAuth 2.0 authentication is enabled (AuthenticationMethod=OAuth2).
Specifies the user name that is used to connect to the REST service. A user name is required if user is enabled by your REST service.