> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown.

# IDataSourceDescriptor

- Package: [@gooddata/sdk-model](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/index.md)
- Kind: interface
- Stability: alpha
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-model/src/dataSources/index.ts

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Data source with its connection details. Secrets, such as passwords or tokens, are never included.

**Signature:**

```typescript
export interface IDataSourceDescriptor extends IDataSourceIdentifierDescriptor 
```
**Extends:** [IDataSourceIdentifierDescriptor](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idatasourceidentifierdescriptor/index.md)

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [alternativeDataSourceId?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idatasourcedescriptor/index.md#idatasourcedescriptoralternativedatasourceid) |  | string \| null | **_(ALPHA)_** _(Optional)_ Identifier of the data source that the backend uses instead of this one. |
| [authenticationType?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idatasourcedescriptor/index.md#idatasourcedescriptorauthenticationtype) |  | [DataSourceAuthenticationType](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.datasourceauthenticationtype/index.md) \| null | **_(ALPHA)_** _(Optional)_ |
| [cacheRetention?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idatasourcedescriptor/index.md#idatasourcedescriptorcacheretention) |  | [DataSourceCacheRetention](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.datasourcecacheretention/index.md) \| null | **_(ALPHA)_** _(Optional)_ |
| [cacheStrategy?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idatasourcedescriptor/index.md#idatasourcedescriptorcachestrategy) |  | [DataSourceCacheStrategy](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.datasourcecachestrategy/index.md) \| null | **_(ALPHA)_** _(Optional)_ |
| [clientId?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idatasourcedescriptor/index.md#idatasourcedescriptorclientid) |  | string | **_(ALPHA)_** _(Optional)_ |
| [dateTimeSemantics?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idatasourcedescriptor/index.md#idatasourcedescriptordatetimesemantics) |  | [DataSourceDateTimeSemantics](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.datasourcedatetimesemantics/index.md) \| null | **_(ALPHA)_** _(Optional)_ |
| [decodedParameters?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idatasourcedescriptor/index.md#idatasourcedescriptordecodedparameters) |  | [IDataSourceParameter](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idatasourceparameter/index.md)[] \| null | **_(ALPHA)_** _(Optional)_ |
| [disableStatistics?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idatasourcedescriptor/index.md#idatasourcedescriptordisablestatistics) |  | boolean \| null | **_(ALPHA)_** _(Optional)_ |
| [ignoreJwtAud?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idatasourcedescriptor/index.md#idatasourcedescriptorignorejwtaud) |  | boolean \| null | **_(ALPHA)_** _(Optional)_ Skip the audience check of JWT tokens in the OIDC authentication. |
| [parameters?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idatasourcedescriptor/index.md#idatasourcedescriptorparameters) |  | [IDataSourceParameter](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idatasourceparameter/index.md)[] \| null | **_(ALPHA)_** _(Optional)_ |
| [permissions?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idatasourcedescriptor/index.md#idatasourcedescriptorpermissions) |  | [DataSourceUserPermission](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.datasourceuserpermission/index.md)[] | **_(ALPHA)_** _(Optional)_ |
| [url?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idatasourcedescriptor/index.md#idatasourcedescriptorurl) |  | string \| null | **_(ALPHA)_** _(Optional)_ |
| [username?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idatasourcedescriptor/index.md#idatasourcedescriptorusername) |  | string | **_(ALPHA)_** _(Optional)_ |

## Property details

### IDataSourceDescriptor.alternativeDataSourceId

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Identifier of the data source that the backend uses instead of this one.

**Signature:**

```typescript
alternativeDataSourceId?: string | null;
```

### IDataSourceDescriptor.authenticationType

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
authenticationType?: DataSourceAuthenticationType | null;
```

### IDataSourceDescriptor.cacheRetention

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
cacheRetention?: DataSourceCacheRetention | null;
```

### IDataSourceDescriptor.cacheStrategy

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
cacheStrategy?: DataSourceCacheStrategy | null;
```

### IDataSourceDescriptor.clientId

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
clientId?: string;
```

### IDataSourceDescriptor.dateTimeSemantics

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
dateTimeSemantics?: DataSourceDateTimeSemantics | null;
```

### IDataSourceDescriptor.decodedParameters

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
decodedParameters?: IDataSourceParameter[] | null;
```

### IDataSourceDescriptor.disableStatistics

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
disableStatistics?: boolean | null;
```

### IDataSourceDescriptor.ignoreJwtAud

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Skip the audience check of JWT tokens in the OIDC authentication.

**Signature:**

```typescript
ignoreJwtAud?: boolean | null;
```

### IDataSourceDescriptor.parameters

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
parameters?: IDataSourceParameter[] | null;
```

### IDataSourceDescriptor.permissions

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
permissions?: DataSourceUserPermission[];
```

### IDataSourceDescriptor.url

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
url?: string | null;
```

### IDataSourceDescriptor.username

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
username?: string;
```