azure_synapse
service
authorizer

Create the Azure Synapse authorizer

Authorizer details to be later used for connection to your Azure Synapse database when reading or writing the data in your data flows.

post/services/azure_synapse

Request

  • Base URL: https://headless.dataddo.com/customer-api/v1
  • URL: https://headless.dataddo.com/customer-api/v1/services/azure_synapse
  • Auth: none declared

Request body

servicestring

Example request

{
  "service": "azure_synapse"
}

Response

Authorizer details to be later used for connection to your Azure Synapse database when reading or writing the data in your data flows.

customer_idstring

The id of the customer (account) the document belongs to.

member_idstring

The id of the member (user) who created the document.

labelstring

Your own textual label for the document. By using labels you can easily identify your documents later.

external_idstring nullable

The id of the document in external systems. By setting external_id you can link document with external systems id.

is_lockedboolean

You may mark the document as locked to prevent accidental changes. When locked, the document cannot be modified or deleted.

statusboolean

The current status of the authorizer. True if the authorizer is operational, false otherwise. When the authorizer is marked as broken (false), it indicates that the authorizer is not functioning properly and may require running test connection or changing the configuration values of such authorizer.

status_detailstring

A detailed message providing additional information about the status of the authorizer. This field can be used to provide more context or troubleshooting information when the authorizer is marked as broken (false).

service_typestring

This field specifies the type of the authorizer, which can be either "template" or "redirect". The "redirect" means that the authorizer requires a redirect to a third-party service for authentication. When "template" all the fields are defined statically in dataddo.

last_useinteger nullable

The timestamp (in seconds) of the last use of the authorizer. The last_use is updated on every use when the authorizer is used for authentication.

identifierstring

The identifier of the authorizer. This field is used to uniquely identify the authorizer. Useful in case when there are multiple authorizers to the same service (e.g. with different user names etc).

hashstring

The hash of the authorizer settings values. Regenerated on every change of the authorizer settings. May be used to uniquely identify the authorizer and check for authorizers with duplicate settings.

created_atinteger

The timestamp (in seconds) of the time when the the authorizer was created

updated_atinteger

The timestamp (in seconds) of the time when the the authorizer was updated for the last time

idinteger
ssh_config_idinteger nullable

Identifier of your already existing SSH tunnel configuration. Leave this empty if you do not want to use any SSH tunnel. If provided, the SSH tunnel will be established using the specified SSH configuration before accessing the taget service.

hoststring

The hostname or IP address of the MSSQL server

instance_namestring

The named instance of the MSSQL server, if applicable

portinteger

The port number the MSSQL server listens on

usernamestring

The username used to authenticate with the MSSQL server

databasestring

The name of the database to connect to

tls'true' | 'skip-verify' | 'preferred' | 'false'
typestring

Example response

{
  "service_type": "template",
  "last_use": 1789381078,
  "identifier": "my@email.com",
  "hash": "asdkjkkfnfy554tgtvcvrr445145"
}

Changes

No recorded changes to this operation across all 1 revision of this API.