Type Alias ConnectionGet

Represents a data connection returned from a GET request.

type ConnectionGet = {
    connectionProperties?: unknown;
    createdAt?: string;
    datasourceID?: string;
    links: dataConnections.Link;
    privileges: dataConnections.Privilege[];
    qArchitecture: 0 | 1;
    qConnectionSecret?: string;
    qConnectStatement: string;
    qCredentialsID?: string;
    qEngineObjectID: string;
    qID: string;
    qLogOn: 0 | 1;
    qName: string;
    qri?: string;
    qSeparateCredentials?: boolean;
    qType: string;
    space?: string;
    tags?: string[];
    tenant: string;
    updated?: string;
    user?: string;
}
Index
connectionProperties? createdAt? datasourceID? links privileges qArchitecture qConnectionSecret? qConnectStatement qCredentialsID? qEngineObjectID qID qLogOn qName qri? qSeparateCredentials? qType space? tags? tenant updated? user?
connectionProperties?: unknown

Connection properties parsed from the connection string. Only included in the response when parseConnection is true.

createdAt?: string

The date and time when the connection was created, in ISO 8601 format.

datasourceID?: string

Data source ID

links: dataConnections.Link
privileges: dataConnections.Privilege[]

The user's access privileges on the associated connection, such as update, delete, or read.

qArchitecture: 0 | 1

Indicates the data connector architecture. 0 for 64-bit, 1 for 32-bit. Default is 0, if not specified.

qConnectionSecret?: string

A connection-specific secret or password. This field is not included in list responses. It is only included when retrieving a single connection using GET /data-connections/{qID}.

qConnectStatement: string

Connection string for the data connection.

qCredentialsID?: string

ID of the credential associated with the connection

qEngineObjectID: string

The unique identifier for the data connection. Must match qID.

qID: string

The unique identifier of the data connection. Must match qEngineObjectID.

qLogOn: 0 | 1

Logon type for the data connection. 0 indicates service user logon; 1 indicates current user logon.

qName: string

Descriptive name of the data connection.

qri?: string

Encrypted base QRI (Qlik Resource Identifier) string for this connection. Only included when includeQris is true. Filterable using SCIM filter expressions, for example: qri co "snowflake".

qSeparateCredentials?: boolean

When true, this connection is credential-less and does not embed authentication details. When false, credentials are embedded in the connection.

qType: string

The connection type, identifying the provider of the underlying connector.

space?: string

ID of the space to which the connection belongs

tags?: string[]

List of tags attached to the connection

tenant: string

Tenant ID of the connection's creator

updated?: string

The date and time when the connection was last updated, in ISO 8601 format.

user?: string

User ID of the connection's creator

Settings
Member Visibility

On This Page
Properties