FireDAC Components for REST

Build 23.0.8804

Connection Parameters

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.


AuthSchemeThe type of authentication to use when connecting to remote services.
AccessKeyYour account access key. This value is accessible from your security credentials page.
SecretKeyYour account secret key. This value is accessible from your security credentials page.
ApiKeyThe API Key used to identify the user to IBM Cloud.
UserThe user account used to authenticate.
PasswordThe password used to authenticate the user.
SharePointEditionThe edition of SharePoint being used. Set either SharePointOnline or SharePointOnPremise.


ConnectionTypeSpecifies the file storage service, server, or file access protocol through which your REST files are stored and retreived.
FormatThe Format property specifies the format reported by the data source.
URIThe Uniform Resource Identifier (URI) for the XML/JSON/CSV resource location.
RegionThe hosting region for your S3-like Web Services.
ProjectIdThe Id of the project where your Google Cloud Storage instance resides.
OracleNamespaceThe Oracle Cloud Object Storage namespace to use.
StorageBaseURLThe URL of a cloud storage service provider.
SimpleUploadLimitThis setting specifies the threshold, in bytes, above which the provider will choose to perform a multipart upload rather than uploading everything in one request.
UseVirtualHostingIf true (default), buckets will be referenced in the request using the hosted-style request: If set to false, the bean will use the path-style request: Note that this property will be set to false, in case of an S3 based custom service when the CustomURL is specified.
UseLakeFormationWhen this property is set to true, AWSLakeFormation service will be used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through OKTA, ADFS, AzureAD, PingFederate, while providing a SAML assertion.

AWS Authentication

AWSAccessKeyYour AWS account access key. This value is accessible from your AWS security credentials page.
AWSSecretKeyYour AWS account secret key. This value is accessible from your AWS security credentials page.
AWSRoleARNThe Amazon Resource Name of the role to use when authenticating.
AWSPrincipalARNThe ARN of the SAML Identity provider in your AWS account.
AWSRegionThe hosting region for your Amazon Web Services.
AWSCredentialsFileThe path to the AWS Credentials File to be used for authentication.
AWSCredentialsFileProfileThe name of the profile to be used from the supplied AWSCredentialsFile.
AWSSessionTokenYour AWS session token.
AWSExternalIdA unique identifier that might be required when you assume a role in another account.
MFASerialNumberThe serial number of the MFA device if one is being used.
MFATokenThe temporary token available from your MFA device.
CredentialsLocationThe location of the settings file where MFA credentials are saved.
TemporaryTokenDurationThe amount of time (in seconds) a temporary token will last.
ServerSideEncryptionWhen activated, file uploads into Amazon S3 buckets will be server-side encrypted.

Azure Authentication

AzureStorageAccountThe name of your Azure storage account.
AzureAccessKeyThe storage key associated with your Azure account.
AzureSharedAccessSignatureA shared access key signature that may be used for authentication.
AzureTenantThe Microsoft Online tenant being used to access data. If not specified, your default tenant is used.
AzureEnvironmentThe Azure Environment to use when establishing a connection.


SSOLoginURLThe identity provider's login URL.
SSOPropertiesAdditional properties required to connect to the identity provider in a semicolon-separated list.
SSOExchangeUrlThe URL used for consuming the SAML response and exchanging it for service specific credentials.


XPathThe XPath of an element that repeats at the same height within the XML/JSON document (used to split the document into multiple rows).
DataModelSpecifies the data model to use when parsing XML/JSON documents and generating the database metadata.
JSONFormatSpecifies the format of the JSON document. Only has an effect when Format is set to JSON.
XMLFormatSpecifies the format of the XML document.
FlattenArraysBy default, nested arrays are returned as strings of XML/JSON. The FlattenArrays property can be used to flatten the elements of nested arrays into columns of their own. Set FlattenArrays to the number of elements you want to return from nested arrays.
FlattenObjectsSet FlattenObjects to true to flatten object properties into columns of their own. Otherwise, objects nested in arrays are returned as strings of XML/JSON.
BackwardsCompatibilityModeSet BackwardsCompatibilityMode to true to use the XML/JSON functionality and features available in the 2017 version.
QualifyColumnsControls whether the provider will use relative column names.
URISeparatorA delimiter used to separate different values in the URI property.


FMTThe format used to parse all CSV files.
IncludeColumnHeadersWhether to get column names from the first line of CSV files.


InitiateOAuthSet this property to initiate the process to obtain or refresh the OAuth access token when you connect.
OAuthVersionThe version of OAuth being used.
OAuthClientIdThe client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecretThe client secret assigned when you register your application with an OAuth authorization server.
OAuthAccessTokenThe access token for connecting using OAuth.
OAuthAccessTokenSecretThe OAuth access token secret for connecting using OAuth.
OAuthSettingsLocationThe location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'.
CallbackURLThe OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
ScopeSpecify scope to obtain the initial access and refresh token.
OAuthGrantTypeThe grant type for the OAuth flow.
OAuthPasswordGrantModeHow to pass Client Id and Secret with OAuthGrantType is set to Password.
OAuthIncludeCallbackURLWhether to include the callback URL in an access token request.
OAuthAuthorizationURLThe authorization URL for the OAuth service.
OAuthAccessTokenURLThe URL to retrieve the OAuth access token from.
OAuthRefreshTokenURLThe URL to refresh the OAuth token from.
OAuthRequestTokenURLThe URL the service provides to retrieve request tokens from. This is required in OAuth 1.0.
OAuthVerifierThe verifier code returned from the OAuth authorization URL.
PKCEVerifierThe PKCE code verifier generated from executing the GetOAuthAuthorizationUrl stored procedure for PKCE authentication schemes.
AuthTokenThe authentication token used to request and obtain the OAuth Access Token.
AuthKeyThe authentication secret used to request and obtain the OAuth Access Token.
OAuthParamsA comma-separated list of other parameters to submit in the request for the OAuth access token in the format paramname=value.
OAuthRefreshTokenThe OAuth refresh token for the corresponding OAuth access token.
OAuthExpiresInThe lifetime in seconds of the OAuth AccessToken.
OAuthTokenTimestampThe Unix epoch timestamp in milliseconds when the current Access Token was created.


OAuthJWTCertThe JWT Certificate store.
OAuthJWTCertTypeThe type of key store containing the JWT Certificate.
OAuthJWTCertPasswordThe password for the OAuth JWT certificate.
OAuthJWTCertSubjectThe subject of the OAuth JWT certificate.
OAuthJWTIssuerThe issuer of the Java Web Token.
OAuthJWTSubjectThe user subject for which the application is requesting delegated access.
OAuthJWTAudienceA space-separated list of entities that may use the JWT.
OAuthJWTEncryptionThe encryption algorithm to be used in JWT authentication.
OAuthJWTHeadersA collection of extra headers that should be included in the JWT headers. Ex: header1=value1,header2=value2.
OAuthJWTValidityTimeHow long the JWT should remain valid, in seconds.


KerberosKDCThe Kerberos Key Distribution Center (KDC) service used to authenticate the user.
KerberosRealmThe Kerberos Realm used to authenticate the user.
KerberosSPNThe service principal name (SPN) for the Kerberos Domain Controller.
KerberosKeytabFileThe Keytab file containing your pairs of Kerberos principals and encrypted keys.
KerberosServiceRealmThe Kerberos realm of the service.
KerberosServiceKDCThe Kerberos KDC of the service.
KerberosTicketCacheThe full file path to an MIT Kerberos credential cache file.


SSLClientCertThe TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).
SSLClientCertTypeThe type of key store containing the TLS/SSL client certificate.
SSLClientCertPasswordThe password for the TLS/SSL client certificate.
SSLClientCertSubjectThe subject of the TLS/SSL client certificate.
SSLModeThe authentication mechanism to be used when connecting to the FTP or FTPS server.
SSLServerCertThe certificate to be accepted from the server when connecting using TLS/SSL.


SSHAuthModeThe authentication method used when establishing an SSH Tunnel to the service.
SSHClientCertA certificate to be used for authenticating the SSHUser.
SSHClientCertPasswordThe password of the SSHClientCert key if it has one.
SSHClientCertSubjectThe subject of the SSH client certificate.
SSHClientCertTypeThe type of SSHClientCert private key.
SSHUserThe SSH user.
SSHPasswordThe SSH password.


FirewallTypeThe protocol used by a proxy-based firewall.
FirewallServerThe name or IP address of a proxy-based firewall.
FirewallPortThe TCP port for a proxy-based firewall.
FirewallUserThe user name to use to authenticate with a proxy-based firewall.
FirewallPasswordA password used to authenticate to a proxy-based firewall.


ProxyAutoDetectThis indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
ProxyServerThe hostname or IP address of a proxy to route HTTP traffic through.
ProxyPortThe TCP port the ProxyServer proxy is running on.
ProxyAuthSchemeThe authentication type to use to authenticate to the ProxyServer proxy.
ProxyUserA user name to be used to authenticate to the ProxyServer proxy.
ProxyPasswordA password to be used to authenticate to the ProxyServer proxy.
ProxySSLTypeThe SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .


LogfileA filepath which designates the name and location of the log file.
VerbosityThe verbosity level that determines the amount of detail included in the log file.
LogModulesCore modules to be included in the log file.
MaxLogFileSizeA string specifying the maximum size in bytes for a log file (for example, 10 MB).
MaxLogFileCountA string specifying the maximum file count of log files.


LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemasThis property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
TablesThis property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
ViewsRestricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.


AutoCacheAutomatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .
CacheProviderThe name of the provider to be used to cache data.
CacheConnectionThe connection string for the cache database. This property is always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data.
CacheLocationSpecifies the path to the cache when caching to a file.
CacheToleranceThe tolerance for stale data in the cache specified in seconds when using AutoCache .
OfflineUse offline mode to get the data from the cache instead of the live source.
CacheMetadataThis property determines whether or not to cache the table metadata to a file store.


CharsetSpecifies the session character set for encoding and decoding character data transferred to and from the REST file. The default value is UTF-8.
ClientCultureThis property can be used to specify the format of data (e.g., currency values) that is accepted by the client application. This property can be used when the client application does not support the machine's culture settings. For example, Microsoft Access requires 'en-US'.
CultureThis setting can be used to specify culture settings that determine how the provider interprets certain data types that are passed into the provider. For example, setting Culture='de-DE' will output German formats even on an American machine.
CustomHeadersOther headers as determined by the user (optional).
CustomUrlParamsThe custom query string to be included in the request.
DataSourceThis property specifies a URI for the resource location.
DirectoryRetrievalDepthLimit the subfolders recursively scanned when IncludeSubdirectories is enabled.
ExcludeFilesComma-separated list of file extensions to exclude from the set of the files modeled as tables.
FolderIdThe ID of a folder in Google Drive. If set, the resource location specified by the URI is relative to the Folder ID for all operations.
GenerateSchemaFilesIndicates the user preference as to when schemas should be generated and saved.
IncludeDropboxTeamResourcesIndicates if you want to include Dropbox team files and folders.
IncludeFilesComma-separated list of file extensions to include into the set of the files modeled as tables.
IncludeItemsFromAllDrivesWhether Google Drive shared drive items should be included in results. If not present or set to false, then shared drive items are not returned.
MaximumColumnSizeThe maximum column size.
MaxRowsLimits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
MetadataDiscoveryURIUsed when aggregating multiple files into one table, this property specifies a specific file to read to determined the aggregated table schema.
OtherThese hidden properties are used only in specific use cases.
PagesizeThe maximum number of results to return per page from REST.
PseudoColumnsThis property indicates whether or not to include pseudo columns as columns to the table.
ReadonlyYou can use this property to enforce read-only access to REST from the provider.
RowScanDepthThe number of rows to scan when dynamically determining columns for the table.
RTKThe runtime key used for licensing.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
TypeDetectionSchemeDetermines how to determine the data types of columns.
UserDefinedViewsA filepath pointing to the JSON configuration file containing your custom views.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8804