> For the complete documentation index, see [llms.txt](https://developer.collibra.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.collibra.com/api/references/edge/models.md). # Models ## The JdbcDriver object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"JdbcDriver":{"type":"object","description":"JDBC driver configuration (`JdbcDriverDirect`). Specify the driver jar, an optional classpath, and the fully qualified driver class name.","oneOf":[{"$ref":"#/components/schemas/JdbcDriverDirect"}],"discriminator":{"propertyName":"type","mapping":{"JdbcDriverDirect":"#/components/schemas/JdbcDriverDirect"}}},"JdbcDriverDirect":{"title":"Direct JDBC Driver","type":"object","properties":{"type":{"type":"string","pattern":"^JdbcDriverDirect$"},"className":{"type":"string","description":"Fully qualified class name of the JDBC driver (e.g. \"org.postgresql.Driver\", \"com.mysql.cj.jdbc.Driver\", etc.).","maxLength":100,"pattern":"^[a-zA-Z0-9._$]+$"},"jar":{"type":"string","format":"uuid","description":"Reference id of the driver jar uploaded via `POST /drivers/jars`."},"additionalClasspathFiles":{"type":"array","maxItems":10,"items":{"type":"string","format":"uuid","description":"Reference id of a driver jar or native library uploaded via `POST /drivers/jars` or `POST /drivers/nativeLibs`."}}},"required":["className","type","jar"],"description":"This schema contains the allowed configuration files that can be uploaded to set up a JDBC connection type."}}}} ``` ## The JdbcDriverDirect object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"JdbcDriverDirect":{"title":"Direct JDBC Driver","type":"object","properties":{"type":{"type":"string","pattern":"^JdbcDriverDirect$"},"className":{"type":"string","description":"Fully qualified class name of the JDBC driver (e.g. \"org.postgresql.Driver\", \"com.mysql.cj.jdbc.Driver\", etc.).","maxLength":100,"pattern":"^[a-zA-Z0-9._$]+$"},"jar":{"type":"string","format":"uuid","description":"Reference id of the driver jar uploaded via `POST /drivers/jars`."},"additionalClasspathFiles":{"type":"array","maxItems":10,"items":{"type":"string","format":"uuid","description":"Reference id of a driver jar or native library uploaded via `POST /drivers/jars` or `POST /drivers/nativeLibs`."}}},"required":["className","type","jar"],"description":"This schema contains the allowed configuration files that can be uploaded to set up a JDBC connection type."}}}} ``` ## The ValueString object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."}}}} ``` ## The ValueRedacted object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}}}}} ``` ## The ValueEdgeArtifactId object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"ValueEdgeArtifactId":{"title":"Edge Artifact ID","description":"References a non-sensitive artifact stored on the Collibra instance and uploaded via `POST /artifacts`. Use for files such as SSL certificates and driver libraries.\n","type":"object","required":["type","edgeArtifactId"],"properties":{"type":{"type":"string","pattern":"^ValueEdgeArtifactId$"},"edgeArtifactId":{"type":"string","format":"uuid","description":"Reference id of the artifact uploaded via `POST /artifacts`."}}}}}} ``` ## The ValueSecretEdgeArtifactId object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"ValueSecretEdgeArtifactId":{"title":"Secret Edge Artifact ID","description":"References a secret artifact stored on the Edge site and uploaded via `POST /sites/{siteId}/secretArtifacts`. The file content never leaves the Edge site cluster. Use for private keys and other sensitive artifacts. Each secret artifact can only be referenced by a single connection and cannot be reused.\n","type":"object","required":["type","secretEdgeArtifactId"],"properties":{"type":{"type":"string","pattern":"^ValueSecretEdgeArtifactId$"},"secretEdgeArtifactId":{"type":"string","maxLength":512,"description":"The `id` value returned by `POST /sites/{siteId}/secretArtifacts`.\n"}}}}}} ``` ## The VaultKeyHashiCorpVaultDatabase object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}}}}} ``` ## The VaultKeyHashiCorpVaultKeyValue object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}}}}} ``` ## The VaultKeyCyberArkCredentialProviderQuery object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}}}}} ``` ## The VaultKeyAWSSecretsManager object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}}}}} ``` ## The VaultKeyAzureKeyVaultSecret object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}}}}} ``` ## The VaultKeyGCPSecretManager object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}}}}} ``` ## The ValueVaultString object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}}}}} ``` ## The ValueVaultArtifact object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"ValueVaultArtifact":{"title":"VaultArtifactReference","description":"Reference to a vault-stored secret that resolves to a file artifact. Use this instead of `EdgeArtifact` when the file should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultArtifact$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}}}}} ``` ## The VaultKeys object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}}}}} ``` ## The ParameterGeneric object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"ParameterGeneric":{"title":"Generic Parameter","description":"A parameter value for use in a data source connection parameter configuration.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueEdgeArtifactId"},{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueSecretEdgeArtifactId"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultArtifact"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueEdgeArtifactId":"#/components/schemas/ValueEdgeArtifactId","ValueRedacted":"#/components/schemas/ValueRedacted","ValueSecretEdgeArtifactId":"#/components/schemas/ValueSecretEdgeArtifactId","ValueString":"#/components/schemas/ValueString","ValueVaultArtifact":"#/components/schemas/ValueVaultArtifact","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueEdgeArtifactId":{"title":"Edge Artifact ID","description":"References a non-sensitive artifact stored on the Collibra instance and uploaded via `POST /artifacts`. Use for files such as SSL certificates and driver libraries.\n","type":"object","required":["type","edgeArtifactId"],"properties":{"type":{"type":"string","pattern":"^ValueEdgeArtifactId$"},"edgeArtifactId":{"type":"string","format":"uuid","description":"Reference id of the artifact uploaded via `POST /artifacts`."}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}},"ValueSecretEdgeArtifactId":{"title":"Secret Edge Artifact ID","description":"References a secret artifact stored on the Edge site and uploaded via `POST /sites/{siteId}/secretArtifacts`. The file content never leaves the Edge site cluster. Use for private keys and other sensitive artifacts. Each secret artifact can only be referenced by a single connection and cannot be reused.\n","type":"object","required":["type","secretEdgeArtifactId"],"properties":{"type":{"type":"string","pattern":"^ValueSecretEdgeArtifactId$"},"secretEdgeArtifactId":{"type":"string","maxLength":512,"description":"The `id` value returned by `POST /sites/{siteId}/secretArtifacts`.\n"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultArtifact":{"title":"VaultArtifactReference","description":"Reference to a vault-stored secret that resolves to a file artifact. Use this instead of `EdgeArtifact` when the file should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultArtifact$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]}}}} ``` ## The ParameterString object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}}}}} ``` ## The ParameterSecretString object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}}}}} ``` ## The ParameterEdgeArtifact object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"ParameterEdgeArtifact":{"description":"References a non-sensitive artifact stored on the customer's Collibra Platform instance. Use for SSL certificates, driver libraries, and other files that do not need to stay within the customer's Edge site.\n","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueEdgeArtifactId"},{"$ref":"#/components/schemas/ValueVaultArtifact"}],"discriminator":{"propertyName":"type","mapping":{"ValueEdgeArtifactId":"#/components/schemas/ValueEdgeArtifactId","ValueVaultArtifact":"#/components/schemas/ValueVaultArtifact"}}},"ValueEdgeArtifactId":{"title":"Edge Artifact ID","description":"References a non-sensitive artifact stored on the Collibra instance and uploaded via `POST /artifacts`. Use for files such as SSL certificates and driver libraries.\n","type":"object","required":["type","edgeArtifactId"],"properties":{"type":{"type":"string","pattern":"^ValueEdgeArtifactId$"},"edgeArtifactId":{"type":"string","format":"uuid","description":"Reference id of the artifact uploaded via `POST /artifacts`."}}},"ValueVaultArtifact":{"title":"VaultArtifactReference","description":"Reference to a vault-stored secret that resolves to a file artifact. Use this instead of `EdgeArtifact` when the file should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultArtifact$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}}}}} ``` ## The ParameterSecretEdgeArtifact object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"ParameterSecretEdgeArtifact":{"description":"References a sensitive artifact stored on the Edge site. The file content never leaves the Edge site cluster. Use for private keys and other sensitive artifacts.\n","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueSecretEdgeArtifactId"},{"$ref":"#/components/schemas/ValueVaultArtifact"}],"discriminator":{"propertyName":"type","mapping":{"ValueSecretEdgeArtifactId":"#/components/schemas/ValueSecretEdgeArtifactId","ValueVaultArtifact":"#/components/schemas/ValueVaultArtifact"}}},"ValueSecretEdgeArtifactId":{"title":"Secret Edge Artifact ID","description":"References a secret artifact stored on the Edge site and uploaded via `POST /sites/{siteId}/secretArtifacts`. The file content never leaves the Edge site cluster. Use for private keys and other sensitive artifacts. Each secret artifact can only be referenced by a single connection and cannot be reused.\n","type":"object","required":["type","secretEdgeArtifactId"],"properties":{"type":{"type":"string","pattern":"^ValueSecretEdgeArtifactId$"},"secretEdgeArtifactId":{"type":"string","maxLength":512,"description":"The `id` value returned by `POST /sites/{siteId}/secretArtifacts`.\n"}}},"ValueVaultArtifact":{"title":"VaultArtifactReference","description":"Reference to a vault-stored secret that resolves to a file artifact. Use this instead of `EdgeArtifact` when the file should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultArtifact$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}}}}} ``` ## The ParameterGenericMap object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"ParameterGenericMap":{"type":"object","description":"Map of parameters for connections used to pass additional configuration.","additionalProperties":{"$ref":"#/components/schemas/ParameterGeneric"}},"ParameterGeneric":{"title":"Generic Parameter","description":"A parameter value for use in a data source connection parameter configuration.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueEdgeArtifactId"},{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueSecretEdgeArtifactId"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultArtifact"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueEdgeArtifactId":"#/components/schemas/ValueEdgeArtifactId","ValueRedacted":"#/components/schemas/ValueRedacted","ValueSecretEdgeArtifactId":"#/components/schemas/ValueSecretEdgeArtifactId","ValueString":"#/components/schemas/ValueString","ValueVaultArtifact":"#/components/schemas/ValueVaultArtifact","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueEdgeArtifactId":{"title":"Edge Artifact ID","description":"References a non-sensitive artifact stored on the Collibra instance and uploaded via `POST /artifacts`. Use for files such as SSL certificates and driver libraries.\n","type":"object","required":["type","edgeArtifactId"],"properties":{"type":{"type":"string","pattern":"^ValueEdgeArtifactId$"},"edgeArtifactId":{"type":"string","format":"uuid","description":"Reference id of the artifact uploaded via `POST /artifacts`."}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}},"ValueSecretEdgeArtifactId":{"title":"Secret Edge Artifact ID","description":"References a secret artifact stored on the Edge site and uploaded via `POST /sites/{siteId}/secretArtifacts`. The file content never leaves the Edge site cluster. Use for private keys and other sensitive artifacts. Each secret artifact can only be referenced by a single connection and cannot be reused.\n","type":"object","required":["type","secretEdgeArtifactId"],"properties":{"type":{"type":"string","pattern":"^ValueSecretEdgeArtifactId$"},"secretEdgeArtifactId":{"type":"string","maxLength":512,"description":"The `id` value returned by `POST /sites/{siteId}/secretArtifacts`.\n"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultArtifact":{"title":"VaultArtifactReference","description":"Reference to a vault-stored secret that resolves to a file artifact. Use this instead of `EdgeArtifact` when the file should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultArtifact$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]}}}} ``` ## The ConnectionProperties object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"ConnectionProperties":{"oneOf":[{"$ref":"#/components/schemas/ConnectionAws"},{"$ref":"#/components/schemas/ConnectionAzure"},{"$ref":"#/components/schemas/ConnectionDatabricks"},{"$ref":"#/components/schemas/ConnectionDbt"},{"$ref":"#/components/schemas/ConnectionGcp"},{"$ref":"#/components/schemas/ConnectionGit"},{"$ref":"#/components/schemas/ConnectionHttp"},{"$ref":"#/components/schemas/ConnectionIics"},{"$ref":"#/components/schemas/ConnectionJdbc"},{"$ref":"#/components/schemas/ConnectionLocalStorage"},{"$ref":"#/components/schemas/ConnectionLooker"},{"$ref":"#/components/schemas/ConnectionMatillion"},{"$ref":"#/components/schemas/ConnectionMicroStrategy"},{"$ref":"#/components/schemas/ConnectionMlflow"},{"$ref":"#/components/schemas/ConnectionPowerBI"},{"$ref":"#/components/schemas/ConnectionS3Compatible"},{"$ref":"#/components/schemas/ConnectionSapAICore"},{"$ref":"#/components/schemas/ConnectionSapDatasphereCatalog"},{"$ref":"#/components/schemas/ConnectionSigma"},{"$ref":"#/components/schemas/ConnectionSnowflake"},{"$ref":"#/components/schemas/ConnectionSsrs"},{"$ref":"#/components/schemas/ConnectionTableau"},{"$ref":"#/components/schemas/ConnectionThoughtSpot"}],"discriminator":{"propertyName":"type","mapping":{"ConnectionAws":"#/components/schemas/ConnectionAws","ConnectionAzure":"#/components/schemas/ConnectionAzure","ConnectionDatabricks":"#/components/schemas/ConnectionDatabricks","ConnectionDbt":"#/components/schemas/ConnectionDbt","ConnectionGcp":"#/components/schemas/ConnectionGcp","ConnectionGit":"#/components/schemas/ConnectionGit","ConnectionHttp":"#/components/schemas/ConnectionHttp","ConnectionIics":"#/components/schemas/ConnectionIics","ConnectionJdbc":"#/components/schemas/ConnectionJdbc","ConnectionLocalStorage":"#/components/schemas/ConnectionLocalStorage","ConnectionLooker":"#/components/schemas/ConnectionLooker","ConnectionMatillion":"#/components/schemas/ConnectionMatillion","ConnectionMicroStrategy":"#/components/schemas/ConnectionMicroStrategy","ConnectionMlflow":"#/components/schemas/ConnectionMlflow","ConnectionPowerBI":"#/components/schemas/ConnectionPowerBI","ConnectionS3Compatible":"#/components/schemas/ConnectionS3Compatible","ConnectionSapAICore":"#/components/schemas/ConnectionSapAICore","ConnectionSapDatasphereCatalog":"#/components/schemas/ConnectionSapDatasphereCatalog","ConnectionSigma":"#/components/schemas/ConnectionSigma","ConnectionSnowflake":"#/components/schemas/ConnectionSnowflake","ConnectionSsrs":"#/components/schemas/ConnectionSsrs","ConnectionTableau":"#/components/schemas/ConnectionTableau","ConnectionThoughtSpot":"#/components/schemas/ConnectionThoughtSpot"}}},"ConnectionAws":{"type":"object","title":"AWS Connection","description":"AWS connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionAws$","description":"Discriminator for AWS connection"},"auth":{"$ref":"#/components/schemas/AuthAws"},"parameters":{"$ref":"#/components/schemas/ParameterGenericMap"}},"required":["type","auth"]},"AuthAws":{"title":"AWS Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthAwsEc2"},{"$ref":"#/components/schemas/AuthAwsIam"}],"discriminator":{"propertyName":"type","mapping":{"AuthAwsEc2":"#/components/schemas/AuthAwsEc2","AuthAwsIam":"#/components/schemas/AuthAwsIam"}}},"AuthAwsEc2":{"title":"AWS EC2 Instance Profile Authentication","type":"object","description":"Authenticate via the IAM role attached to the EC2 instance running the Edge site. No credentials are configured on the connection.","properties":{"type":{"type":"string","pattern":"^AuthAwsEc2$"}},"required":["type"]},"AuthAwsIam":{"title":"AWS IAM Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthAwsIam$"},"awsAccessKeyId":{"description":"AWS Access Key ID","$ref":"#/components/schemas/ParameterString"},"awsSecretKey":{"description":"AWS Secret Access Key","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","awsAccessKeyId","awsSecretKey"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}},"ParameterGenericMap":{"type":"object","description":"Map of parameters for connections used to pass additional configuration.","additionalProperties":{"$ref":"#/components/schemas/ParameterGeneric"}},"ParameterGeneric":{"title":"Generic Parameter","description":"A parameter value for use in a data source connection parameter configuration.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueEdgeArtifactId"},{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueSecretEdgeArtifactId"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultArtifact"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueEdgeArtifactId":"#/components/schemas/ValueEdgeArtifactId","ValueRedacted":"#/components/schemas/ValueRedacted","ValueSecretEdgeArtifactId":"#/components/schemas/ValueSecretEdgeArtifactId","ValueString":"#/components/schemas/ValueString","ValueVaultArtifact":"#/components/schemas/ValueVaultArtifact","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueEdgeArtifactId":{"title":"Edge Artifact ID","description":"References a non-sensitive artifact stored on the Collibra instance and uploaded via `POST /artifacts`. Use for files such as SSL certificates and driver libraries.\n","type":"object","required":["type","edgeArtifactId"],"properties":{"type":{"type":"string","pattern":"^ValueEdgeArtifactId$"},"edgeArtifactId":{"type":"string","format":"uuid","description":"Reference id of the artifact uploaded via `POST /artifacts`."}}},"ValueSecretEdgeArtifactId":{"title":"Secret Edge Artifact ID","description":"References a secret artifact stored on the Edge site and uploaded via `POST /sites/{siteId}/secretArtifacts`. The file content never leaves the Edge site cluster. Use for private keys and other sensitive artifacts. Each secret artifact can only be referenced by a single connection and cannot be reused.\n","type":"object","required":["type","secretEdgeArtifactId"],"properties":{"type":{"type":"string","pattern":"^ValueSecretEdgeArtifactId$"},"secretEdgeArtifactId":{"type":"string","maxLength":512,"description":"The `id` value returned by `POST /sites/{siteId}/secretArtifacts`.\n"}}},"ValueVaultArtifact":{"title":"VaultArtifactReference","description":"Reference to a vault-stored secret that resolves to a file artifact. Use this instead of `EdgeArtifact` when the file should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultArtifact$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"ConnectionAzure":{"type":"object","title":"Azure Connection","description":"Azure connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionAzure$","description":"Discriminator for Azure connection"},"usGovernmentCloudHost":{"description":"Indicates whether Azure US Government Cloud is the host for Microsoft Entra.","type":"boolean","default":false},"auth":{"$ref":"#/components/schemas/AuthAzure"}},"required":["type","auth"]},"AuthAzure":{"title":"Azure Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthAzureServicePrincipal"}],"discriminator":{"propertyName":"type","mapping":{"AuthAzureServicePrincipal":"#/components/schemas/AuthAzureServicePrincipal"}}},"AuthAzureServicePrincipal":{"type":"object","title":"Azure Service Principal Authentication","properties":{"type":{"type":"string","pattern":"^AuthAzureServicePrincipal$"},"clientId":{"description":"The ID of the Service Principal used to connect to Azure","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"The Secret Key for the Service Principal","$ref":"#/components/schemas/ParameterSecretString"},"tenantId":{"description":"The Tenant ID of your Azure AD","$ref":"#/components/schemas/ParameterString"}},"required":["type","clientId","clientSecret","tenantId"]},"ConnectionDatabricks":{"type":"object","title":"Databricks Connection","description":"Databricks connection.","properties":{"type":{"type":"string","pattern":"^ConnectionDatabricks$","description":"Discriminator for Databricks connection."},"workspaceUrl":{"description":"Workspace URL on Databricks.","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthDatabricks"}},"required":["type","workspaceUrl","auth"]},"AuthDatabricks":{"title":"Databricks Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthClientCredentials"},{"$ref":"#/components/schemas/AuthDatabricksEntraId"},{"$ref":"#/components/schemas/AuthToken"}],"discriminator":{"propertyName":"type","mapping":{"AuthClientCredentials":"#/components/schemas/AuthClientCredentials","AuthDatabricksEntraId":"#/components/schemas/AuthDatabricksEntraId","AuthToken":"#/components/schemas/AuthToken"}}},"AuthClientCredentials":{"title":"Client Credentials Authentication","type":"object","description":"Generic client credentials (client ID + secret) authentication, reusable across connection types.","properties":{"type":{"type":"string","pattern":"^AuthClientCredentials$"},"clientId":{"description":"Client ID","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","clientId","clientSecret"]},"AuthDatabricksEntraId":{"title":"Databricks Microsoft Entra ID Authentication","type":"object","description":"Microsoft Entra ID (Azure AD) authentication for Databricks.","properties":{"type":{"type":"string","pattern":"^AuthDatabricksEntraId$"},"clientId":{"description":"Client ID of the Microsoft Entra ID service principal.","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret of the Microsoft Entra ID service principal.","$ref":"#/components/schemas/ParameterSecretString"},"tenantId":{"description":"Tenant ID for Microsoft Entra ID authentication.","$ref":"#/components/schemas/ParameterString"}},"required":["type","clientId","clientSecret","tenantId"]},"AuthToken":{"title":"Token Authentication","type":"object","description":"Generic single-token authentication, reusable across connection types.","properties":{"type":{"type":"string","pattern":"^AuthToken$"},"token":{"description":"Token value for authentication.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","token"]},"ConnectionDbt":{"type":"object","title":"dbt Connection","description":"dbt connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionDbt$","description":"Discriminator for dbt Connection"},"adminUrl":{"description":"Optional dbt admin API URL. Defaults to https://cloud.getdbt.com/api/v2","$ref":"#/components/schemas/ParameterString"},"metadataUrl":{"description":"Optional dbt metadata URL. Defaults to https://metadata.cloud.getdbt.com/graphql","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthDbt"}},"required":["type","auth"]},"AuthDbt":{"title":"dbt Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthDbtToken"}],"discriminator":{"propertyName":"type","mapping":{"AuthDbtToken":"#/components/schemas/AuthDbtToken"}}},"AuthDbtToken":{"title":"dbt Token Authentication","type":"object","description":"A dbt Cloud service token with the required permissions, used for authentication.","properties":{"type":{"type":"string","pattern":"^AuthDbtToken$"},"tokenName":{"description":"Name of the service/account token (any unique meaningful name can be used)","$ref":"#/components/schemas/ParameterString"},"tokenValue":{"description":"Value of the service/account token (the copied value from dbt Cloud)","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","tokenName","tokenValue"]},"ConnectionGcp":{"type":"object","title":"GCP Connection","description":"GCP connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionGcp$","description":"Discriminator for GCP Connection"},"auth":{"$ref":"#/components/schemas/AuthGcp"},"parameters":{"$ref":"#/components/schemas/ParameterGenericMap"}},"required":["type","auth"]},"AuthGcp":{"title":"GCP Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthGcpServiceAccount"},{"$ref":"#/components/schemas/AuthGcpWif"},{"$ref":"#/components/schemas/AuthGcpWifGke"}],"discriminator":{"propertyName":"type","mapping":{"AuthGcpServiceAccount":"#/components/schemas/AuthGcpServiceAccount","AuthGcpWif":"#/components/schemas/AuthGcpWif","AuthGcpWifGke":"#/components/schemas/AuthGcpWifGke"}}},"AuthGcpServiceAccount":{"title":"GCP Service Account Authentication","type":"object","description":"GCP Service Account authentication (full JSON key)","properties":{"type":{"type":"string","pattern":"^AuthGcpServiceAccount$"},"credentialsJson":{"description":"Full JSON key for the service account","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","credentialsJson"]},"AuthGcpWif":{"title":"GCP Workload Identity Federation (WIF) Authentication","type":"object","description":"Workload Identity Federation (WIF) - token URL or token","properties":{"type":{"type":"string","pattern":"^AuthGcpWif$"},"tokenOrTokenUrl":{"description":"Token URL or token for WIF","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","tokenOrTokenUrl"]},"AuthGcpWifGke":{"title":"GCP Workload Identity Federation (WIF) using GKE Authentication","type":"object","description":"Workload Identity Federation (WIF) using GKE - credentials from GKE, leave blank","properties":{"type":{"type":"string","pattern":"^AuthGcpWifGke$"}},"required":["type"]},"ConnectionGit":{"type":"object","title":"Git Connection","description":"Connection to a Git repository\n","properties":{"type":{"type":"string","pattern":"^ConnectionGit$","description":"Discriminator for Git connection"},"repositoryUrl":{"description":"HTTPS URL of the Git repository root, e.g. https://github.com/org/repo.git","$ref":"#/components/schemas/ParameterString"},"subfolder":{"description":"Path to a specific subfolder within the repository, e.g. src or projects/analytics.","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthGit"}},"required":["type","repositoryUrl","auth"]},"AuthGit":{"title":"Git Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthGitAccessToken"}],"discriminator":{"propertyName":"type","mapping":{"AuthGitAccessToken":"#/components/schemas/AuthGitAccessToken"}}},"AuthGitAccessToken":{"title":"Git Access Token Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthGitAccessToken$"},"username":{"description":"Username for authentication. Required for Bitbucket repositories.","$ref":"#/components/schemas/ParameterString"},"accessToken":{"description":"Personal access token for authenticating with the Git repository.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","accessToken"]},"ConnectionHttp":{"type":"object","title":"HTTP Connection","description":"Allows workflows to communicate with other HTTP based systems.\n","properties":{"type":{"type":"string","pattern":"^ConnectionHttp$","description":"Discriminator for HTTP connection"},"host":{"description":"The protocol and domain name of the server to connect to, for example, https://api.example.com","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthHttp"},"testConnectionPath":{"description":"The path for testing this connection with a GET call, for example, /v1/health.","$ref":"#/components/schemas/ParameterString"}},"required":["type","host"]},"AuthHttp":{"title":"HTTP Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthNone"},{"$ref":"#/components/schemas/AuthOAuth2"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthNone":"#/components/schemas/AuthNone","AuthOAuth2":"#/components/schemas/AuthOAuth2"}}},"AuthBasic":{"title":"Basic Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthBasic$"},"username":{"description":"Username","$ref":"#/components/schemas/ParameterString"},"password":{"description":"Password","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","username","password"]},"AuthNone":{"title":"No Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthNone$"}},"required":["type"]},"AuthOAuth2":{"title":"OAuth 2.0 Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthOAuth2$"},"clientId":{"description":"Client id","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret","$ref":"#/components/schemas/ParameterSecretString"},"accessTokenUri":{"description":"Access token URI","$ref":"#/components/schemas/ParameterString"},"scopes":{"description":"Scopes","$ref":"#/components/schemas/ParameterString"}},"required":["type","clientId","clientSecret","accessTokenUri"]},"ConnectionIics":{"type":"object","title":"Informatica Intelligent Cloud Services (IICS) Connection","description":"IICS connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionIics$","description":"Discriminator for Informatica Intelligent Cloud Services (IICS) Connection"},"url":{"description":"IICS Url","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthIics"}},"required":["type","url","auth"]},"AuthIics":{"title":"IICS Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic"}}},"ConnectionJdbc":{"title":"JDBC Connection","type":"object","required":["type","driver","connectionString"],"properties":{"type":{"type":"string","pattern":"^ConnectionJdbc$","description":"Discriminator for JDBC connection types."},"driver":{"$ref":"#/components/schemas/JdbcDriver"},"connectionString":{"$ref":"#/components/schemas/ParameterString","description":"JDBC connection string, e.g. \"jdbc:mysql://localhost:3306/mydb\""},"auth":{"description":"Authentication configuration. When omitted, defaults to AuthNone.","$ref":"#/components/schemas/AuthJdbc"},"parameters":{"description":"Additional JDBC connection properties, such as SSL settings, timeouts, etc. These are passed as key-value pairs in the connection string.","allOf":[{"$ref":"#/components/schemas/ParameterGenericMap"}]}}},"JdbcDriver":{"type":"object","description":"JDBC driver configuration (`JdbcDriverDirect`). Specify the driver jar, an optional classpath, and the fully qualified driver class name.","oneOf":[{"$ref":"#/components/schemas/JdbcDriverDirect"}],"discriminator":{"propertyName":"type","mapping":{"JdbcDriverDirect":"#/components/schemas/JdbcDriverDirect"}}},"JdbcDriverDirect":{"title":"Direct JDBC Driver","type":"object","properties":{"type":{"type":"string","pattern":"^JdbcDriverDirect$"},"className":{"type":"string","description":"Fully qualified class name of the JDBC driver (e.g. \"org.postgresql.Driver\", \"com.mysql.cj.jdbc.Driver\", etc.).","maxLength":100,"pattern":"^[a-zA-Z0-9._$]+$"},"jar":{"type":"string","format":"uuid","description":"Reference id of the driver jar uploaded via `POST /drivers/jars`."},"additionalClasspathFiles":{"type":"array","maxItems":10,"items":{"type":"string","format":"uuid","description":"Reference id of a driver jar or native library uploaded via `POST /drivers/jars` or `POST /drivers/nativeLibs`."}}},"required":["className","type","jar"],"description":"This schema contains the allowed configuration files that can be uploaded to set up a JDBC connection type."},"AuthJdbc":{"title":"JDBC Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthNone"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthNone":"#/components/schemas/AuthNone"}}},"ConnectionLocalStorage":{"type":"object","title":"Shared Storage Connection","description":"Read-only access to a folder located on the Edge site. Used for technical lineage ingestion via OpenLineage (AWS Glue, Apache Airflow, OpenLineage).\n","properties":{"type":{"type":"string","pattern":"^ConnectionLocalStorage$","description":"Discriminator for shared storage connection"},"folder":{"description":"--target as specified in ./edgecli object folder-upload","type":"string","pattern":"^[\\w-]+$"}},"required":["type","folder"]},"ConnectionLooker":{"type":"object","title":"Looker Connection","description":"Looker connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionLooker$","description":"Discriminator for Looker Connection"},"url":{"description":"Looker URL","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthLooker"}},"required":["type","url","auth"]},"AuthLooker":{"title":"Looker Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthClientCredentials"}],"discriminator":{"propertyName":"type","mapping":{"AuthClientCredentials":"#/components/schemas/AuthClientCredentials"}}},"ConnectionMatillion":{"type":"object","title":"Matillion Connection","description":"Matillion connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionMatillion$","description":"Discriminator for Matillion Connection"},"url":{"description":"Matillion Url","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthMatillion"},"certFile":{"description":"Custom certificate","$ref":"#/components/schemas/ParameterEdgeArtifact"}},"required":["type","url","auth"]},"AuthMatillion":{"title":"Matillion Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthToken"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthToken":"#/components/schemas/AuthToken"}}},"ParameterEdgeArtifact":{"description":"References a non-sensitive artifact stored on the customer's Collibra Platform instance. Use for SSL certificates, driver libraries, and other files that do not need to stay within the customer's Edge site.\n","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueEdgeArtifactId"},{"$ref":"#/components/schemas/ValueVaultArtifact"}],"discriminator":{"propertyName":"type","mapping":{"ValueEdgeArtifactId":"#/components/schemas/ValueEdgeArtifactId","ValueVaultArtifact":"#/components/schemas/ValueVaultArtifact"}}},"ConnectionMicroStrategy":{"type":"object","title":"MicroStrategy Connection","description":"MicroStrategy connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionMicroStrategy$","description":"Discriminator for MicroStrategy Connection"},"url":{"description":"MicroStrategy URL","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthMicroStrategy"}},"required":["type","url","auth"]},"AuthMicroStrategy":{"title":"MicroStrategy Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthToken"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthToken":"#/components/schemas/AuthToken"}}},"ConnectionMlflow":{"type":"object","title":"MLflow Connection","description":"MLflow connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionMlflow$","description":"Discriminator for MLflow connection"},"url":{"description":"MLflow URL","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthMlflow"}},"required":["type","url","auth"]},"AuthMlflow":{"title":"MLflow Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthClientCredentialsWithTokenUrl"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthClientCredentialsWithTokenUrl":"#/components/schemas/AuthClientCredentialsWithTokenUrl"}}},"AuthClientCredentialsWithTokenUrl":{"title":"Client Credentials with Token URL Authentication","type":"object","description":"OAuth client credentials with token URL (client ID, secret, and token endpoint)","properties":{"type":{"type":"string","pattern":"^AuthClientCredentialsWithTokenUrl$"},"clientId":{"description":"Client ID","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret","$ref":"#/components/schemas/ParameterSecretString"},"tokenUrl":{"description":"The token URL of the OAuth client","$ref":"#/components/schemas/ParameterString"}},"required":["type","clientId","clientSecret","tokenUrl"]},"ConnectionPowerBI":{"type":"object","title":"Power BI Connection","description":"Power BI (SaaS) connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionPowerBI$","description":"Discriminator for Power BI Connection"},"tenantDomain":{"description":"Tenant Domain","$ref":"#/components/schemas/ParameterString"},"auth":{"description":"Authentication configuration for Power BI. Supports ServicePrincipal and ResourceOwnerPassword flows.\n","$ref":"#/components/schemas/AuthPowerBI"},"certFile":{"description":"Optional custom SSL/TLS certificate, in PEM format, used to establish a trusted HTTPS connection to the Power BI service. Provide this when the connection is routed through a proxy or gateway that presents a certificate signed by a custom or private Certificate Authority that is not trusted by default. The certificate is referenced as a non-sensitive artifact stored on the customer's Collibra Platform instance. When omitted, the system's default trusted CAs are used.\n","$ref":"#/components/schemas/ParameterEdgeArtifact"}},"required":["type","tenantDomain","auth"]},"AuthPowerBI":{"title":"Power BI Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthPowerBIResourceOwnerPassword"},{"$ref":"#/components/schemas/AuthPowerBIServicePrincipal"}],"discriminator":{"propertyName":"type","mapping":{"AuthPowerBIResourceOwnerPassword":"#/components/schemas/AuthPowerBIResourceOwnerPassword","AuthPowerBIServicePrincipal":"#/components/schemas/AuthPowerBIServicePrincipal"}}},"AuthPowerBIResourceOwnerPassword":{"title":"Power BI Resource Owner Password Credentials Authentication","type":"object","description":"Resource Owner Password Credentials authentication for Power BI","properties":{"type":{"type":"string","pattern":"^AuthPowerBIResourceOwnerPassword$"},"applicationId":{"description":"Application ID","$ref":"#/components/schemas/ParameterString"},"username":{"description":"Username","$ref":"#/components/schemas/ParameterString"},"passwordSecretKey":{"description":"Password/Secret key","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","applicationId","username","passwordSecretKey"]},"AuthPowerBIServicePrincipal":{"title":"Power BI Service Principal Authentication","type":"object","description":"Service Principal authentication for Power BI","properties":{"type":{"type":"string","pattern":"^AuthPowerBIServicePrincipal$"},"applicationId":{"description":"Application ID","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret for the service principal","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","applicationId","clientSecret"]},"ConnectionS3Compatible":{"type":"object","title":"S3-Compatible Connection","description":"Connection to a self-hosted or third-party S3-compatible storage service (e.g. MinIO, Ceph, NetApp StorageGRID).\n","properties":{"type":{"type":"string","pattern":"^ConnectionS3Compatible$","description":"Discriminator for S3-Compatible connection"},"endpoint":{"description":"URL of the S3-compatible storage endpoint, e.g. https://minio.example.com","$ref":"#/components/schemas/ParameterString"},"region":{"description":"Region identifier for the S3-compatible storage service.","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthS3Compatible"}},"required":["type","endpoint","auth"]},"AuthS3Compatible":{"title":"S3-Compatible Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthS3CompatibleAccessKey"}],"discriminator":{"propertyName":"type","mapping":{"AuthS3CompatibleAccessKey":"#/components/schemas/AuthS3CompatibleAccessKey"}}},"AuthS3CompatibleAccessKey":{"title":"S3-Compatible Access Key Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthS3CompatibleAccessKey$"},"accessKeyId":{"description":"Access key ID for the S3-compatible storage service.","$ref":"#/components/schemas/ParameterString"},"secretAccessKey":{"description":"Secret access key for the S3-compatible storage service.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","accessKeyId","secretAccessKey"]},"ConnectionSapAICore":{"type":"object","title":"SAP AI Core Connection","description":"SAP AI Core connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionSapAICore$","description":"Discriminator for SAP AI Core connection"},"url":{"description":"SAP AI Core URL","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthSapAICore"}},"required":["type","url","auth"]},"AuthSapAICore":{"title":"SAP AI Core Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthClientCredentialsWithTokenUrl"}],"discriminator":{"propertyName":"type","mapping":{"AuthClientCredentialsWithTokenUrl":"#/components/schemas/AuthClientCredentialsWithTokenUrl"}}},"ConnectionSapDatasphereCatalog":{"type":"object","title":"SAP Datasphere Catalog Connection","description":"SAP Datasphere Catalog connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionSapDatasphereCatalog$","description":"Discriminator for SAP Datasphere Catalog connection"},"url":{"description":"SAP Datasphere Catalog URL","$ref":"#/components/schemas/ParameterString"},"datasphereCatalogAuth":{"description":"OAuth client credentials for ingesting the SAP Datasphere Catalog.","$ref":"#/components/schemas/AuthSapDatasphereCatalog"},"dataProductsAuth":{"description":"Optional OAuth client credentials for ingesting SAP Data Products. When omitted, SAP Data Products are not ingested.","$ref":"#/components/schemas/AuthClientCredentials"}},"required":["type","url","datasphereCatalogAuth"]},"AuthSapDatasphereCatalog":{"title":"SAP Datasphere Catalog Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthClientCredentialsWithTokenUrl"}],"discriminator":{"propertyName":"type","mapping":{"AuthClientCredentialsWithTokenUrl":"#/components/schemas/AuthClientCredentialsWithTokenUrl"}}},"ConnectionSigma":{"type":"object","title":"Sigma Connection","description":"Sigma connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionSigma$","description":"Discriminator for Sigma connection"},"url":{"description":"Sigma instance base URL, e.g. https://aws-api.sigmacomputing.com","$ref":"#/components/schemas/ParameterString"},"tenantUrl":{"description":"Tenant-specific URL, e.g. https://app.sigmacomputing.com/your-tenant","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthSigma"}},"required":["type","url","tenantUrl","auth"]},"AuthSigma":{"title":"Sigma Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthClientCredentials"}],"discriminator":{"propertyName":"type","mapping":{"AuthClientCredentials":"#/components/schemas/AuthClientCredentials"}}},"ConnectionSnowflake":{"type":"object","title":"Snowflake Connection","description":"Snowflake connection.","properties":{"type":{"type":"string","pattern":"^ConnectionSnowflake$","description":"Discriminator for Snowflake connection."},"account":{"description":"The Account Identifier for the Snowflake account. This often includes cloud region information (e.g., xy123456.eu-central-1).","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthSnowflake"},"role":{"description":"The role to use in the Snowflake session.","$ref":"#/components/schemas/ParameterString"},"warehouse":{"description":"The name of the Snowflake warehouse. Defaults to the user's default warehouse if not specified.","$ref":"#/components/schemas/ParameterString"}},"required":["type","account","auth"]},"AuthSnowflake":{"title":"Snowflake Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthSnowflakeKeyPair"},{"$ref":"#/components/schemas/AuthSnowflakePat"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthSnowflakeKeyPair":"#/components/schemas/AuthSnowflakeKeyPair","AuthSnowflakePat":"#/components/schemas/AuthSnowflakePat"}}},"AuthSnowflakeKeyPair":{"title":"Snowflake Key Pair Authentication","type":"object","description":"Key pair authentication for Snowflake.","properties":{"type":{"type":"string","pattern":"^AuthSnowflakeKeyPair$"},"username":{"description":"The username to authenticate against the Snowflake account.","$ref":"#/components/schemas/ParameterString"},"privateKeyEdgeArtifact":{"description":"The private key artifact in P8 format for key pair authentication.","$ref":"#/components/schemas/ParameterSecretEdgeArtifact"},"privateKeyPwd":{"description":"The passphrase for the private key, if it is encrypted.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","username","privateKeyEdgeArtifact"]},"ParameterSecretEdgeArtifact":{"description":"References a sensitive artifact stored on the Edge site. The file content never leaves the Edge site cluster. Use for private keys and other sensitive artifacts.\n","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueSecretEdgeArtifactId"},{"$ref":"#/components/schemas/ValueVaultArtifact"}],"discriminator":{"propertyName":"type","mapping":{"ValueSecretEdgeArtifactId":"#/components/schemas/ValueSecretEdgeArtifactId","ValueVaultArtifact":"#/components/schemas/ValueVaultArtifact"}}},"AuthSnowflakePat":{"title":"Snowflake Programmatic Access Token Authentication","type":"object","description":"Programmatic Access Token (PAT) authentication for Snowflake.","properties":{"type":{"type":"string","pattern":"^AuthSnowflakePat$"},"programmaticAccessToken":{"description":"Programmatic Access Token generated in Snowflake.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","programmaticAccessToken"]},"ConnectionSsrs":{"type":"object","title":"Microsoft SSRS/PBRS Connection","description":"Microsoft SSRS/PBRS connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionSsrs$","description":"Discriminator for Microsoft SSRS/PBRS Connection"},"url":{"description":"Microsoft SSRS/PBRS URL","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthSsrs"}},"required":["type","url","auth"]},"AuthSsrs":{"title":"SSRS Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic"}}},"ConnectionTableau":{"type":"object","title":"Tableau Connection","description":"Tableau connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionTableau$","description":"Discriminator for Tableau Connection"},"url":{"description":"URL of the Tableau Server or Tableau Cloud site.","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthTableau"},"certFile":{"description":"Custom certificate","$ref":"#/components/schemas/ParameterEdgeArtifact"}},"required":["type","url","auth"]},"AuthTableau":{"title":"Tableau Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthTableauToken"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthTableauToken":"#/components/schemas/AuthTableauToken"}}},"AuthTableauToken":{"title":"Tableau Token Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthTableauToken$"},"tokenName":{"description":"Name of the service/account token (any unique meaningful name can be used)","$ref":"#/components/schemas/ParameterString"},"tokenSecret":{"description":"Value of the service/account token","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","tokenName","tokenSecret"]},"ConnectionThoughtSpot":{"type":"object","title":"ThoughtSpot Connection","description":"ThoughtSpot connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionThoughtSpot$","description":"Discriminator for ThoughtSpot connection"},"url":{"description":"ThoughtSpot instance base URL, e.g. https://customer.thoughtspot.cloud","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthThoughtSpot"}},"required":["type","url","auth"]},"AuthThoughtSpot":{"title":"ThoughtSpot Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic"}}}}}} ``` ## The ConnectionAws object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"ConnectionAws":{"type":"object","title":"AWS Connection","description":"AWS connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionAws$","description":"Discriminator for AWS connection"},"auth":{"$ref":"#/components/schemas/AuthAws"},"parameters":{"$ref":"#/components/schemas/ParameterGenericMap"}},"required":["type","auth"]},"AuthAws":{"title":"AWS Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthAwsEc2"},{"$ref":"#/components/schemas/AuthAwsIam"}],"discriminator":{"propertyName":"type","mapping":{"AuthAwsEc2":"#/components/schemas/AuthAwsEc2","AuthAwsIam":"#/components/schemas/AuthAwsIam"}}},"AuthAwsEc2":{"title":"AWS EC2 Instance Profile Authentication","type":"object","description":"Authenticate via the IAM role attached to the EC2 instance running the Edge site. No credentials are configured on the connection.","properties":{"type":{"type":"string","pattern":"^AuthAwsEc2$"}},"required":["type"]},"AuthAwsIam":{"title":"AWS IAM Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthAwsIam$"},"awsAccessKeyId":{"description":"AWS Access Key ID","$ref":"#/components/schemas/ParameterString"},"awsSecretKey":{"description":"AWS Secret Access Key","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","awsAccessKeyId","awsSecretKey"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}},"ParameterGenericMap":{"type":"object","description":"Map of parameters for connections used to pass additional configuration.","additionalProperties":{"$ref":"#/components/schemas/ParameterGeneric"}},"ParameterGeneric":{"title":"Generic Parameter","description":"A parameter value for use in a data source connection parameter configuration.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueEdgeArtifactId"},{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueSecretEdgeArtifactId"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultArtifact"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueEdgeArtifactId":"#/components/schemas/ValueEdgeArtifactId","ValueRedacted":"#/components/schemas/ValueRedacted","ValueSecretEdgeArtifactId":"#/components/schemas/ValueSecretEdgeArtifactId","ValueString":"#/components/schemas/ValueString","ValueVaultArtifact":"#/components/schemas/ValueVaultArtifact","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueEdgeArtifactId":{"title":"Edge Artifact ID","description":"References a non-sensitive artifact stored on the Collibra instance and uploaded via `POST /artifacts`. Use for files such as SSL certificates and driver libraries.\n","type":"object","required":["type","edgeArtifactId"],"properties":{"type":{"type":"string","pattern":"^ValueEdgeArtifactId$"},"edgeArtifactId":{"type":"string","format":"uuid","description":"Reference id of the artifact uploaded via `POST /artifacts`."}}},"ValueSecretEdgeArtifactId":{"title":"Secret Edge Artifact ID","description":"References a secret artifact stored on the Edge site and uploaded via `POST /sites/{siteId}/secretArtifacts`. The file content never leaves the Edge site cluster. Use for private keys and other sensitive artifacts. Each secret artifact can only be referenced by a single connection and cannot be reused.\n","type":"object","required":["type","secretEdgeArtifactId"],"properties":{"type":{"type":"string","pattern":"^ValueSecretEdgeArtifactId$"},"secretEdgeArtifactId":{"type":"string","maxLength":512,"description":"The `id` value returned by `POST /sites/{siteId}/secretArtifacts`.\n"}}},"ValueVaultArtifact":{"title":"VaultArtifactReference","description":"Reference to a vault-stored secret that resolves to a file artifact. Use this instead of `EdgeArtifact` when the file should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultArtifact$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]}}}} ``` ## The ConnectionAzure object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"ConnectionAzure":{"type":"object","title":"Azure Connection","description":"Azure connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionAzure$","description":"Discriminator for Azure connection"},"usGovernmentCloudHost":{"description":"Indicates whether Azure US Government Cloud is the host for Microsoft Entra.","type":"boolean","default":false},"auth":{"$ref":"#/components/schemas/AuthAzure"}},"required":["type","auth"]},"AuthAzure":{"title":"Azure Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthAzureServicePrincipal"}],"discriminator":{"propertyName":"type","mapping":{"AuthAzureServicePrincipal":"#/components/schemas/AuthAzureServicePrincipal"}}},"AuthAzureServicePrincipal":{"type":"object","title":"Azure Service Principal Authentication","properties":{"type":{"type":"string","pattern":"^AuthAzureServicePrincipal$"},"clientId":{"description":"The ID of the Service Principal used to connect to Azure","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"The Secret Key for the Service Principal","$ref":"#/components/schemas/ParameterSecretString"},"tenantId":{"description":"The Tenant ID of your Azure AD","$ref":"#/components/schemas/ParameterString"}},"required":["type","clientId","clientSecret","tenantId"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}}}}} ``` ## The ConnectionDatabricks object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"ConnectionDatabricks":{"type":"object","title":"Databricks Connection","description":"Databricks connection.","properties":{"type":{"type":"string","pattern":"^ConnectionDatabricks$","description":"Discriminator for Databricks connection."},"workspaceUrl":{"description":"Workspace URL on Databricks.","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthDatabricks"}},"required":["type","workspaceUrl","auth"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"AuthDatabricks":{"title":"Databricks Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthClientCredentials"},{"$ref":"#/components/schemas/AuthDatabricksEntraId"},{"$ref":"#/components/schemas/AuthToken"}],"discriminator":{"propertyName":"type","mapping":{"AuthClientCredentials":"#/components/schemas/AuthClientCredentials","AuthDatabricksEntraId":"#/components/schemas/AuthDatabricksEntraId","AuthToken":"#/components/schemas/AuthToken"}}},"AuthClientCredentials":{"title":"Client Credentials Authentication","type":"object","description":"Generic client credentials (client ID + secret) authentication, reusable across connection types.","properties":{"type":{"type":"string","pattern":"^AuthClientCredentials$"},"clientId":{"description":"Client ID","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","clientId","clientSecret"]},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}},"AuthDatabricksEntraId":{"title":"Databricks Microsoft Entra ID Authentication","type":"object","description":"Microsoft Entra ID (Azure AD) authentication for Databricks.","properties":{"type":{"type":"string","pattern":"^AuthDatabricksEntraId$"},"clientId":{"description":"Client ID of the Microsoft Entra ID service principal.","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret of the Microsoft Entra ID service principal.","$ref":"#/components/schemas/ParameterSecretString"},"tenantId":{"description":"Tenant ID for Microsoft Entra ID authentication.","$ref":"#/components/schemas/ParameterString"}},"required":["type","clientId","clientSecret","tenantId"]},"AuthToken":{"title":"Token Authentication","type":"object","description":"Generic single-token authentication, reusable across connection types.","properties":{"type":{"type":"string","pattern":"^AuthToken$"},"token":{"description":"Token value for authentication.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","token"]}}}} ``` ## The ConnectionDbt object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"ConnectionDbt":{"type":"object","title":"dbt Connection","description":"dbt connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionDbt$","description":"Discriminator for dbt Connection"},"adminUrl":{"description":"Optional dbt admin API URL. Defaults to https://cloud.getdbt.com/api/v2","$ref":"#/components/schemas/ParameterString"},"metadataUrl":{"description":"Optional dbt metadata URL. Defaults to https://metadata.cloud.getdbt.com/graphql","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthDbt"}},"required":["type","auth"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"AuthDbt":{"title":"dbt Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthDbtToken"}],"discriminator":{"propertyName":"type","mapping":{"AuthDbtToken":"#/components/schemas/AuthDbtToken"}}},"AuthDbtToken":{"title":"dbt Token Authentication","type":"object","description":"A dbt Cloud service token with the required permissions, used for authentication.","properties":{"type":{"type":"string","pattern":"^AuthDbtToken$"},"tokenName":{"description":"Name of the service/account token (any unique meaningful name can be used)","$ref":"#/components/schemas/ParameterString"},"tokenValue":{"description":"Value of the service/account token (the copied value from dbt Cloud)","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","tokenName","tokenValue"]},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}}}}} ``` ## The ConnectionGcp object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"ConnectionGcp":{"type":"object","title":"GCP Connection","description":"GCP connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionGcp$","description":"Discriminator for GCP Connection"},"auth":{"$ref":"#/components/schemas/AuthGcp"},"parameters":{"$ref":"#/components/schemas/ParameterGenericMap"}},"required":["type","auth"]},"AuthGcp":{"title":"GCP Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthGcpServiceAccount"},{"$ref":"#/components/schemas/AuthGcpWif"},{"$ref":"#/components/schemas/AuthGcpWifGke"}],"discriminator":{"propertyName":"type","mapping":{"AuthGcpServiceAccount":"#/components/schemas/AuthGcpServiceAccount","AuthGcpWif":"#/components/schemas/AuthGcpWif","AuthGcpWifGke":"#/components/schemas/AuthGcpWifGke"}}},"AuthGcpServiceAccount":{"title":"GCP Service Account Authentication","type":"object","description":"GCP Service Account authentication (full JSON key)","properties":{"type":{"type":"string","pattern":"^AuthGcpServiceAccount$"},"credentialsJson":{"description":"Full JSON key for the service account","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","credentialsJson"]},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"AuthGcpWif":{"title":"GCP Workload Identity Federation (WIF) Authentication","type":"object","description":"Workload Identity Federation (WIF) - token URL or token","properties":{"type":{"type":"string","pattern":"^AuthGcpWif$"},"tokenOrTokenUrl":{"description":"Token URL or token for WIF","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","tokenOrTokenUrl"]},"AuthGcpWifGke":{"title":"GCP Workload Identity Federation (WIF) using GKE Authentication","type":"object","description":"Workload Identity Federation (WIF) using GKE - credentials from GKE, leave blank","properties":{"type":{"type":"string","pattern":"^AuthGcpWifGke$"}},"required":["type"]},"ParameterGenericMap":{"type":"object","description":"Map of parameters for connections used to pass additional configuration.","additionalProperties":{"$ref":"#/components/schemas/ParameterGeneric"}},"ParameterGeneric":{"title":"Generic Parameter","description":"A parameter value for use in a data source connection parameter configuration.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueEdgeArtifactId"},{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueSecretEdgeArtifactId"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultArtifact"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueEdgeArtifactId":"#/components/schemas/ValueEdgeArtifactId","ValueRedacted":"#/components/schemas/ValueRedacted","ValueSecretEdgeArtifactId":"#/components/schemas/ValueSecretEdgeArtifactId","ValueString":"#/components/schemas/ValueString","ValueVaultArtifact":"#/components/schemas/ValueVaultArtifact","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueEdgeArtifactId":{"title":"Edge Artifact ID","description":"References a non-sensitive artifact stored on the Collibra instance and uploaded via `POST /artifacts`. Use for files such as SSL certificates and driver libraries.\n","type":"object","required":["type","edgeArtifactId"],"properties":{"type":{"type":"string","pattern":"^ValueEdgeArtifactId$"},"edgeArtifactId":{"type":"string","format":"uuid","description":"Reference id of the artifact uploaded via `POST /artifacts`."}}},"ValueSecretEdgeArtifactId":{"title":"Secret Edge Artifact ID","description":"References a secret artifact stored on the Edge site and uploaded via `POST /sites/{siteId}/secretArtifacts`. The file content never leaves the Edge site cluster. Use for private keys and other sensitive artifacts. Each secret artifact can only be referenced by a single connection and cannot be reused.\n","type":"object","required":["type","secretEdgeArtifactId"],"properties":{"type":{"type":"string","pattern":"^ValueSecretEdgeArtifactId$"},"secretEdgeArtifactId":{"type":"string","maxLength":512,"description":"The `id` value returned by `POST /sites/{siteId}/secretArtifacts`.\n"}}},"ValueVaultArtifact":{"title":"VaultArtifactReference","description":"Reference to a vault-stored secret that resolves to a file artifact. Use this instead of `EdgeArtifact` when the file should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultArtifact$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]}}}} ``` ## The ConnectionGit object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"ConnectionGit":{"type":"object","title":"Git Connection","description":"Connection to a Git repository\n","properties":{"type":{"type":"string","pattern":"^ConnectionGit$","description":"Discriminator for Git connection"},"repositoryUrl":{"description":"HTTPS URL of the Git repository root, e.g. https://github.com/org/repo.git","$ref":"#/components/schemas/ParameterString"},"subfolder":{"description":"Path to a specific subfolder within the repository, e.g. src or projects/analytics.","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthGit"}},"required":["type","repositoryUrl","auth"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"AuthGit":{"title":"Git Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthGitAccessToken"}],"discriminator":{"propertyName":"type","mapping":{"AuthGitAccessToken":"#/components/schemas/AuthGitAccessToken"}}},"AuthGitAccessToken":{"title":"Git Access Token Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthGitAccessToken$"},"username":{"description":"Username for authentication. Required for Bitbucket repositories.","$ref":"#/components/schemas/ParameterString"},"accessToken":{"description":"Personal access token for authenticating with the Git repository.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","accessToken"]},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}}}}} ``` ## The ConnectionHttp object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"ConnectionHttp":{"type":"object","title":"HTTP Connection","description":"Allows workflows to communicate with other HTTP based systems.\n","properties":{"type":{"type":"string","pattern":"^ConnectionHttp$","description":"Discriminator for HTTP connection"},"host":{"description":"The protocol and domain name of the server to connect to, for example, https://api.example.com","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthHttp"},"testConnectionPath":{"description":"The path for testing this connection with a GET call, for example, /v1/health.","$ref":"#/components/schemas/ParameterString"}},"required":["type","host"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"AuthHttp":{"title":"HTTP Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthNone"},{"$ref":"#/components/schemas/AuthOAuth2"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthNone":"#/components/schemas/AuthNone","AuthOAuth2":"#/components/schemas/AuthOAuth2"}}},"AuthBasic":{"title":"Basic Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthBasic$"},"username":{"description":"Username","$ref":"#/components/schemas/ParameterString"},"password":{"description":"Password","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","username","password"]},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}},"AuthNone":{"title":"No Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthNone$"}},"required":["type"]},"AuthOAuth2":{"title":"OAuth 2.0 Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthOAuth2$"},"clientId":{"description":"Client id","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret","$ref":"#/components/schemas/ParameterSecretString"},"accessTokenUri":{"description":"Access token URI","$ref":"#/components/schemas/ParameterString"},"scopes":{"description":"Scopes","$ref":"#/components/schemas/ParameterString"}},"required":["type","clientId","clientSecret","accessTokenUri"]}}}} ``` ## The ConnectionIics object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"ConnectionIics":{"type":"object","title":"Informatica Intelligent Cloud Services (IICS) Connection","description":"IICS connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionIics$","description":"Discriminator for Informatica Intelligent Cloud Services (IICS) Connection"},"url":{"description":"IICS Url","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthIics"}},"required":["type","url","auth"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"AuthIics":{"title":"IICS Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic"}}},"AuthBasic":{"title":"Basic Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthBasic$"},"username":{"description":"Username","$ref":"#/components/schemas/ParameterString"},"password":{"description":"Password","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","username","password"]},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}}}}} ``` ## The ConnectionJdbc object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"ConnectionJdbc":{"title":"JDBC Connection","type":"object","required":["type","driver","connectionString"],"properties":{"type":{"type":"string","pattern":"^ConnectionJdbc$","description":"Discriminator for JDBC connection types."},"driver":{"$ref":"#/components/schemas/JdbcDriver"},"connectionString":{"$ref":"#/components/schemas/ParameterString","description":"JDBC connection string, e.g. \"jdbc:mysql://localhost:3306/mydb\""},"auth":{"description":"Authentication configuration. When omitted, defaults to AuthNone.","$ref":"#/components/schemas/AuthJdbc"},"parameters":{"description":"Additional JDBC connection properties, such as SSL settings, timeouts, etc. These are passed as key-value pairs in the connection string.","allOf":[{"$ref":"#/components/schemas/ParameterGenericMap"}]}}},"JdbcDriver":{"type":"object","description":"JDBC driver configuration (`JdbcDriverDirect`). Specify the driver jar, an optional classpath, and the fully qualified driver class name.","oneOf":[{"$ref":"#/components/schemas/JdbcDriverDirect"}],"discriminator":{"propertyName":"type","mapping":{"JdbcDriverDirect":"#/components/schemas/JdbcDriverDirect"}}},"JdbcDriverDirect":{"title":"Direct JDBC Driver","type":"object","properties":{"type":{"type":"string","pattern":"^JdbcDriverDirect$"},"className":{"type":"string","description":"Fully qualified class name of the JDBC driver (e.g. \"org.postgresql.Driver\", \"com.mysql.cj.jdbc.Driver\", etc.).","maxLength":100,"pattern":"^[a-zA-Z0-9._$]+$"},"jar":{"type":"string","format":"uuid","description":"Reference id of the driver jar uploaded via `POST /drivers/jars`."},"additionalClasspathFiles":{"type":"array","maxItems":10,"items":{"type":"string","format":"uuid","description":"Reference id of a driver jar or native library uploaded via `POST /drivers/jars` or `POST /drivers/nativeLibs`."}}},"required":["className","type","jar"],"description":"This schema contains the allowed configuration files that can be uploaded to set up a JDBC connection type."},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"AuthJdbc":{"title":"JDBC Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthNone"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthNone":"#/components/schemas/AuthNone"}}},"AuthBasic":{"title":"Basic Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthBasic$"},"username":{"description":"Username","$ref":"#/components/schemas/ParameterString"},"password":{"description":"Password","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","username","password"]},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}},"AuthNone":{"title":"No Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthNone$"}},"required":["type"]},"ParameterGenericMap":{"type":"object","description":"Map of parameters for connections used to pass additional configuration.","additionalProperties":{"$ref":"#/components/schemas/ParameterGeneric"}},"ParameterGeneric":{"title":"Generic Parameter","description":"A parameter value for use in a data source connection parameter configuration.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueEdgeArtifactId"},{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueSecretEdgeArtifactId"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultArtifact"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueEdgeArtifactId":"#/components/schemas/ValueEdgeArtifactId","ValueRedacted":"#/components/schemas/ValueRedacted","ValueSecretEdgeArtifactId":"#/components/schemas/ValueSecretEdgeArtifactId","ValueString":"#/components/schemas/ValueString","ValueVaultArtifact":"#/components/schemas/ValueVaultArtifact","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueEdgeArtifactId":{"title":"Edge Artifact ID","description":"References a non-sensitive artifact stored on the Collibra instance and uploaded via `POST /artifacts`. Use for files such as SSL certificates and driver libraries.\n","type":"object","required":["type","edgeArtifactId"],"properties":{"type":{"type":"string","pattern":"^ValueEdgeArtifactId$"},"edgeArtifactId":{"type":"string","format":"uuid","description":"Reference id of the artifact uploaded via `POST /artifacts`."}}},"ValueSecretEdgeArtifactId":{"title":"Secret Edge Artifact ID","description":"References a secret artifact stored on the Edge site and uploaded via `POST /sites/{siteId}/secretArtifacts`. The file content never leaves the Edge site cluster. Use for private keys and other sensitive artifacts. Each secret artifact can only be referenced by a single connection and cannot be reused.\n","type":"object","required":["type","secretEdgeArtifactId"],"properties":{"type":{"type":"string","pattern":"^ValueSecretEdgeArtifactId$"},"secretEdgeArtifactId":{"type":"string","maxLength":512,"description":"The `id` value returned by `POST /sites/{siteId}/secretArtifacts`.\n"}}},"ValueVaultArtifact":{"title":"VaultArtifactReference","description":"Reference to a vault-stored secret that resolves to a file artifact. Use this instead of `EdgeArtifact` when the file should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultArtifact$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]}}}} ``` ## The ConnectionLocalStorage object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"ConnectionLocalStorage":{"type":"object","title":"Shared Storage Connection","description":"Read-only access to a folder located on the Edge site. Used for technical lineage ingestion via OpenLineage (AWS Glue, Apache Airflow, OpenLineage).\n","properties":{"type":{"type":"string","pattern":"^ConnectionLocalStorage$","description":"Discriminator for shared storage connection"},"folder":{"description":"--target as specified in ./edgecli object folder-upload","type":"string","pattern":"^[\\w-]+$"}},"required":["type","folder"]}}}} ``` ## The ConnectionLooker object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"ConnectionLooker":{"type":"object","title":"Looker Connection","description":"Looker connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionLooker$","description":"Discriminator for Looker Connection"},"url":{"description":"Looker URL","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthLooker"}},"required":["type","url","auth"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"AuthLooker":{"title":"Looker Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthClientCredentials"}],"discriminator":{"propertyName":"type","mapping":{"AuthClientCredentials":"#/components/schemas/AuthClientCredentials"}}},"AuthClientCredentials":{"title":"Client Credentials Authentication","type":"object","description":"Generic client credentials (client ID + secret) authentication, reusable across connection types.","properties":{"type":{"type":"string","pattern":"^AuthClientCredentials$"},"clientId":{"description":"Client ID","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","clientId","clientSecret"]},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}}}}} ``` ## The ConnectionMatillion object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"ConnectionMatillion":{"type":"object","title":"Matillion Connection","description":"Matillion connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionMatillion$","description":"Discriminator for Matillion Connection"},"url":{"description":"Matillion Url","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthMatillion"},"certFile":{"description":"Custom certificate","$ref":"#/components/schemas/ParameterEdgeArtifact"}},"required":["type","url","auth"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"AuthMatillion":{"title":"Matillion Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthToken"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthToken":"#/components/schemas/AuthToken"}}},"AuthBasic":{"title":"Basic Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthBasic$"},"username":{"description":"Username","$ref":"#/components/schemas/ParameterString"},"password":{"description":"Password","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","username","password"]},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}},"AuthToken":{"title":"Token Authentication","type":"object","description":"Generic single-token authentication, reusable across connection types.","properties":{"type":{"type":"string","pattern":"^AuthToken$"},"token":{"description":"Token value for authentication.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","token"]},"ParameterEdgeArtifact":{"description":"References a non-sensitive artifact stored on the customer's Collibra Platform instance. Use for SSL certificates, driver libraries, and other files that do not need to stay within the customer's Edge site.\n","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueEdgeArtifactId"},{"$ref":"#/components/schemas/ValueVaultArtifact"}],"discriminator":{"propertyName":"type","mapping":{"ValueEdgeArtifactId":"#/components/schemas/ValueEdgeArtifactId","ValueVaultArtifact":"#/components/schemas/ValueVaultArtifact"}}},"ValueEdgeArtifactId":{"title":"Edge Artifact ID","description":"References a non-sensitive artifact stored on the Collibra instance and uploaded via `POST /artifacts`. Use for files such as SSL certificates and driver libraries.\n","type":"object","required":["type","edgeArtifactId"],"properties":{"type":{"type":"string","pattern":"^ValueEdgeArtifactId$"},"edgeArtifactId":{"type":"string","format":"uuid","description":"Reference id of the artifact uploaded via `POST /artifacts`."}}},"ValueVaultArtifact":{"title":"VaultArtifactReference","description":"Reference to a vault-stored secret that resolves to a file artifact. Use this instead of `EdgeArtifact` when the file should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultArtifact$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]}}}} ``` ## The ConnectionMicroStrategy object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"ConnectionMicroStrategy":{"type":"object","title":"MicroStrategy Connection","description":"MicroStrategy connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionMicroStrategy$","description":"Discriminator for MicroStrategy Connection"},"url":{"description":"MicroStrategy URL","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthMicroStrategy"}},"required":["type","url","auth"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"AuthMicroStrategy":{"title":"MicroStrategy Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthToken"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthToken":"#/components/schemas/AuthToken"}}},"AuthBasic":{"title":"Basic Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthBasic$"},"username":{"description":"Username","$ref":"#/components/schemas/ParameterString"},"password":{"description":"Password","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","username","password"]},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}},"AuthToken":{"title":"Token Authentication","type":"object","description":"Generic single-token authentication, reusable across connection types.","properties":{"type":{"type":"string","pattern":"^AuthToken$"},"token":{"description":"Token value for authentication.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","token"]}}}} ``` ## The ConnectionMlflow object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"ConnectionMlflow":{"type":"object","title":"MLflow Connection","description":"MLflow connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionMlflow$","description":"Discriminator for MLflow connection"},"url":{"description":"MLflow URL","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthMlflow"}},"required":["type","url","auth"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"AuthMlflow":{"title":"MLflow Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthClientCredentialsWithTokenUrl"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthClientCredentialsWithTokenUrl":"#/components/schemas/AuthClientCredentialsWithTokenUrl"}}},"AuthBasic":{"title":"Basic Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthBasic$"},"username":{"description":"Username","$ref":"#/components/schemas/ParameterString"},"password":{"description":"Password","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","username","password"]},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}},"AuthClientCredentialsWithTokenUrl":{"title":"Client Credentials with Token URL Authentication","type":"object","description":"OAuth client credentials with token URL (client ID, secret, and token endpoint)","properties":{"type":{"type":"string","pattern":"^AuthClientCredentialsWithTokenUrl$"},"clientId":{"description":"Client ID","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret","$ref":"#/components/schemas/ParameterSecretString"},"tokenUrl":{"description":"The token URL of the OAuth client","$ref":"#/components/schemas/ParameterString"}},"required":["type","clientId","clientSecret","tokenUrl"]}}}} ``` ## The ConnectionPowerBI object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"ConnectionPowerBI":{"type":"object","title":"Power BI Connection","description":"Power BI (SaaS) connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionPowerBI$","description":"Discriminator for Power BI Connection"},"tenantDomain":{"description":"Tenant Domain","$ref":"#/components/schemas/ParameterString"},"auth":{"description":"Authentication configuration for Power BI. Supports ServicePrincipal and ResourceOwnerPassword flows.\n","$ref":"#/components/schemas/AuthPowerBI"},"certFile":{"description":"Optional custom SSL/TLS certificate, in PEM format, used to establish a trusted HTTPS connection to the Power BI service. Provide this when the connection is routed through a proxy or gateway that presents a certificate signed by a custom or private Certificate Authority that is not trusted by default. The certificate is referenced as a non-sensitive artifact stored on the customer's Collibra Platform instance. When omitted, the system's default trusted CAs are used.\n","$ref":"#/components/schemas/ParameterEdgeArtifact"}},"required":["type","tenantDomain","auth"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"AuthPowerBI":{"title":"Power BI Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthPowerBIResourceOwnerPassword"},{"$ref":"#/components/schemas/AuthPowerBIServicePrincipal"}],"discriminator":{"propertyName":"type","mapping":{"AuthPowerBIResourceOwnerPassword":"#/components/schemas/AuthPowerBIResourceOwnerPassword","AuthPowerBIServicePrincipal":"#/components/schemas/AuthPowerBIServicePrincipal"}}},"AuthPowerBIResourceOwnerPassword":{"title":"Power BI Resource Owner Password Credentials Authentication","type":"object","description":"Resource Owner Password Credentials authentication for Power BI","properties":{"type":{"type":"string","pattern":"^AuthPowerBIResourceOwnerPassword$"},"applicationId":{"description":"Application ID","$ref":"#/components/schemas/ParameterString"},"username":{"description":"Username","$ref":"#/components/schemas/ParameterString"},"passwordSecretKey":{"description":"Password/Secret key","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","applicationId","username","passwordSecretKey"]},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}},"AuthPowerBIServicePrincipal":{"title":"Power BI Service Principal Authentication","type":"object","description":"Service Principal authentication for Power BI","properties":{"type":{"type":"string","pattern":"^AuthPowerBIServicePrincipal$"},"applicationId":{"description":"Application ID","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret for the service principal","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","applicationId","clientSecret"]},"ParameterEdgeArtifact":{"description":"References a non-sensitive artifact stored on the customer's Collibra Platform instance. Use for SSL certificates, driver libraries, and other files that do not need to stay within the customer's Edge site.\n","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueEdgeArtifactId"},{"$ref":"#/components/schemas/ValueVaultArtifact"}],"discriminator":{"propertyName":"type","mapping":{"ValueEdgeArtifactId":"#/components/schemas/ValueEdgeArtifactId","ValueVaultArtifact":"#/components/schemas/ValueVaultArtifact"}}},"ValueEdgeArtifactId":{"title":"Edge Artifact ID","description":"References a non-sensitive artifact stored on the Collibra instance and uploaded via `POST /artifacts`. Use for files such as SSL certificates and driver libraries.\n","type":"object","required":["type","edgeArtifactId"],"properties":{"type":{"type":"string","pattern":"^ValueEdgeArtifactId$"},"edgeArtifactId":{"type":"string","format":"uuid","description":"Reference id of the artifact uploaded via `POST /artifacts`."}}},"ValueVaultArtifact":{"title":"VaultArtifactReference","description":"Reference to a vault-stored secret that resolves to a file artifact. Use this instead of `EdgeArtifact` when the file should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultArtifact$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]}}}} ``` ## The ConnectionS3Compatible object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"ConnectionS3Compatible":{"type":"object","title":"S3-Compatible Connection","description":"Connection to a self-hosted or third-party S3-compatible storage service (e.g. MinIO, Ceph, NetApp StorageGRID).\n","properties":{"type":{"type":"string","pattern":"^ConnectionS3Compatible$","description":"Discriminator for S3-Compatible connection"},"endpoint":{"description":"URL of the S3-compatible storage endpoint, e.g. https://minio.example.com","$ref":"#/components/schemas/ParameterString"},"region":{"description":"Region identifier for the S3-compatible storage service.","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthS3Compatible"}},"required":["type","endpoint","auth"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"AuthS3Compatible":{"title":"S3-Compatible Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthS3CompatibleAccessKey"}],"discriminator":{"propertyName":"type","mapping":{"AuthS3CompatibleAccessKey":"#/components/schemas/AuthS3CompatibleAccessKey"}}},"AuthS3CompatibleAccessKey":{"title":"S3-Compatible Access Key Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthS3CompatibleAccessKey$"},"accessKeyId":{"description":"Access key ID for the S3-compatible storage service.","$ref":"#/components/schemas/ParameterString"},"secretAccessKey":{"description":"Secret access key for the S3-compatible storage service.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","accessKeyId","secretAccessKey"]},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}}}}} ``` ## The ConnectionSapAICore object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"ConnectionSapAICore":{"type":"object","title":"SAP AI Core Connection","description":"SAP AI Core connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionSapAICore$","description":"Discriminator for SAP AI Core connection"},"url":{"description":"SAP AI Core URL","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthSapAICore"}},"required":["type","url","auth"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"AuthSapAICore":{"title":"SAP AI Core Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthClientCredentialsWithTokenUrl"}],"discriminator":{"propertyName":"type","mapping":{"AuthClientCredentialsWithTokenUrl":"#/components/schemas/AuthClientCredentialsWithTokenUrl"}}},"AuthClientCredentialsWithTokenUrl":{"title":"Client Credentials with Token URL Authentication","type":"object","description":"OAuth client credentials with token URL (client ID, secret, and token endpoint)","properties":{"type":{"type":"string","pattern":"^AuthClientCredentialsWithTokenUrl$"},"clientId":{"description":"Client ID","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret","$ref":"#/components/schemas/ParameterSecretString"},"tokenUrl":{"description":"The token URL of the OAuth client","$ref":"#/components/schemas/ParameterString"}},"required":["type","clientId","clientSecret","tokenUrl"]},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}}}}} ``` ## The ConnectionSapDatasphereCatalog object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"ConnectionSapDatasphereCatalog":{"type":"object","title":"SAP Datasphere Catalog Connection","description":"SAP Datasphere Catalog connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionSapDatasphereCatalog$","description":"Discriminator for SAP Datasphere Catalog connection"},"url":{"description":"SAP Datasphere Catalog URL","$ref":"#/components/schemas/ParameterString"},"datasphereCatalogAuth":{"description":"OAuth client credentials for ingesting the SAP Datasphere Catalog.","$ref":"#/components/schemas/AuthSapDatasphereCatalog"},"dataProductsAuth":{"description":"Optional OAuth client credentials for ingesting SAP Data Products. When omitted, SAP Data Products are not ingested.","$ref":"#/components/schemas/AuthClientCredentials"}},"required":["type","url","datasphereCatalogAuth"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"AuthSapDatasphereCatalog":{"title":"SAP Datasphere Catalog Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthClientCredentialsWithTokenUrl"}],"discriminator":{"propertyName":"type","mapping":{"AuthClientCredentialsWithTokenUrl":"#/components/schemas/AuthClientCredentialsWithTokenUrl"}}},"AuthClientCredentialsWithTokenUrl":{"title":"Client Credentials with Token URL Authentication","type":"object","description":"OAuth client credentials with token URL (client ID, secret, and token endpoint)","properties":{"type":{"type":"string","pattern":"^AuthClientCredentialsWithTokenUrl$"},"clientId":{"description":"Client ID","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret","$ref":"#/components/schemas/ParameterSecretString"},"tokenUrl":{"description":"The token URL of the OAuth client","$ref":"#/components/schemas/ParameterString"}},"required":["type","clientId","clientSecret","tokenUrl"]},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}},"AuthClientCredentials":{"title":"Client Credentials Authentication","type":"object","description":"Generic client credentials (client ID + secret) authentication, reusable across connection types.","properties":{"type":{"type":"string","pattern":"^AuthClientCredentials$"},"clientId":{"description":"Client ID","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","clientId","clientSecret"]}}}} ``` ## The ConnectionSigma object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"ConnectionSigma":{"type":"object","title":"Sigma Connection","description":"Sigma connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionSigma$","description":"Discriminator for Sigma connection"},"url":{"description":"Sigma instance base URL, e.g. https://aws-api.sigmacomputing.com","$ref":"#/components/schemas/ParameterString"},"tenantUrl":{"description":"Tenant-specific URL, e.g. https://app.sigmacomputing.com/your-tenant","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthSigma"}},"required":["type","url","tenantUrl","auth"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"AuthSigma":{"title":"Sigma Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthClientCredentials"}],"discriminator":{"propertyName":"type","mapping":{"AuthClientCredentials":"#/components/schemas/AuthClientCredentials"}}},"AuthClientCredentials":{"title":"Client Credentials Authentication","type":"object","description":"Generic client credentials (client ID + secret) authentication, reusable across connection types.","properties":{"type":{"type":"string","pattern":"^AuthClientCredentials$"},"clientId":{"description":"Client ID","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","clientId","clientSecret"]},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}}}}} ``` ## The ConnectionSnowflake object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"ConnectionSnowflake":{"type":"object","title":"Snowflake Connection","description":"Snowflake connection.","properties":{"type":{"type":"string","pattern":"^ConnectionSnowflake$","description":"Discriminator for Snowflake connection."},"account":{"description":"The Account Identifier for the Snowflake account. This often includes cloud region information (e.g., xy123456.eu-central-1).","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthSnowflake"},"role":{"description":"The role to use in the Snowflake session.","$ref":"#/components/schemas/ParameterString"},"warehouse":{"description":"The name of the Snowflake warehouse. Defaults to the user's default warehouse if not specified.","$ref":"#/components/schemas/ParameterString"}},"required":["type","account","auth"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"AuthSnowflake":{"title":"Snowflake Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthSnowflakeKeyPair"},{"$ref":"#/components/schemas/AuthSnowflakePat"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthSnowflakeKeyPair":"#/components/schemas/AuthSnowflakeKeyPair","AuthSnowflakePat":"#/components/schemas/AuthSnowflakePat"}}},"AuthBasic":{"title":"Basic Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthBasic$"},"username":{"description":"Username","$ref":"#/components/schemas/ParameterString"},"password":{"description":"Password","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","username","password"]},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}},"AuthSnowflakeKeyPair":{"title":"Snowflake Key Pair Authentication","type":"object","description":"Key pair authentication for Snowflake.","properties":{"type":{"type":"string","pattern":"^AuthSnowflakeKeyPair$"},"username":{"description":"The username to authenticate against the Snowflake account.","$ref":"#/components/schemas/ParameterString"},"privateKeyEdgeArtifact":{"description":"The private key artifact in P8 format for key pair authentication.","$ref":"#/components/schemas/ParameterSecretEdgeArtifact"},"privateKeyPwd":{"description":"The passphrase for the private key, if it is encrypted.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","username","privateKeyEdgeArtifact"]},"ParameterSecretEdgeArtifact":{"description":"References a sensitive artifact stored on the Edge site. The file content never leaves the Edge site cluster. Use for private keys and other sensitive artifacts.\n","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueSecretEdgeArtifactId"},{"$ref":"#/components/schemas/ValueVaultArtifact"}],"discriminator":{"propertyName":"type","mapping":{"ValueSecretEdgeArtifactId":"#/components/schemas/ValueSecretEdgeArtifactId","ValueVaultArtifact":"#/components/schemas/ValueVaultArtifact"}}},"ValueSecretEdgeArtifactId":{"title":"Secret Edge Artifact ID","description":"References a secret artifact stored on the Edge site and uploaded via `POST /sites/{siteId}/secretArtifacts`. The file content never leaves the Edge site cluster. Use for private keys and other sensitive artifacts. Each secret artifact can only be referenced by a single connection and cannot be reused.\n","type":"object","required":["type","secretEdgeArtifactId"],"properties":{"type":{"type":"string","pattern":"^ValueSecretEdgeArtifactId$"},"secretEdgeArtifactId":{"type":"string","maxLength":512,"description":"The `id` value returned by `POST /sites/{siteId}/secretArtifacts`.\n"}}},"ValueVaultArtifact":{"title":"VaultArtifactReference","description":"Reference to a vault-stored secret that resolves to a file artifact. Use this instead of `EdgeArtifact` when the file should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultArtifact$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"AuthSnowflakePat":{"title":"Snowflake Programmatic Access Token Authentication","type":"object","description":"Programmatic Access Token (PAT) authentication for Snowflake.","properties":{"type":{"type":"string","pattern":"^AuthSnowflakePat$"},"programmaticAccessToken":{"description":"Programmatic Access Token generated in Snowflake.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","programmaticAccessToken"]}}}} ``` ## The ConnectionSsrs object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"ConnectionSsrs":{"type":"object","title":"Microsoft SSRS/PBRS Connection","description":"Microsoft SSRS/PBRS connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionSsrs$","description":"Discriminator for Microsoft SSRS/PBRS Connection"},"url":{"description":"Microsoft SSRS/PBRS URL","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthSsrs"}},"required":["type","url","auth"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"AuthSsrs":{"title":"SSRS Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic"}}},"AuthBasic":{"title":"Basic Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthBasic$"},"username":{"description":"Username","$ref":"#/components/schemas/ParameterString"},"password":{"description":"Password","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","username","password"]},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}}}}} ``` ## The ConnectionTableau object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"ConnectionTableau":{"type":"object","title":"Tableau Connection","description":"Tableau connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionTableau$","description":"Discriminator for Tableau Connection"},"url":{"description":"URL of the Tableau Server or Tableau Cloud site.","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthTableau"},"certFile":{"description":"Custom certificate","$ref":"#/components/schemas/ParameterEdgeArtifact"}},"required":["type","url","auth"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"AuthTableau":{"title":"Tableau Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthTableauToken"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthTableauToken":"#/components/schemas/AuthTableauToken"}}},"AuthBasic":{"title":"Basic Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthBasic$"},"username":{"description":"Username","$ref":"#/components/schemas/ParameterString"},"password":{"description":"Password","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","username","password"]},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}},"AuthTableauToken":{"title":"Tableau Token Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthTableauToken$"},"tokenName":{"description":"Name of the service/account token (any unique meaningful name can be used)","$ref":"#/components/schemas/ParameterString"},"tokenSecret":{"description":"Value of the service/account token","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","tokenName","tokenSecret"]},"ParameterEdgeArtifact":{"description":"References a non-sensitive artifact stored on the customer's Collibra Platform instance. Use for SSL certificates, driver libraries, and other files that do not need to stay within the customer's Edge site.\n","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueEdgeArtifactId"},{"$ref":"#/components/schemas/ValueVaultArtifact"}],"discriminator":{"propertyName":"type","mapping":{"ValueEdgeArtifactId":"#/components/schemas/ValueEdgeArtifactId","ValueVaultArtifact":"#/components/schemas/ValueVaultArtifact"}}},"ValueEdgeArtifactId":{"title":"Edge Artifact ID","description":"References a non-sensitive artifact stored on the Collibra instance and uploaded via `POST /artifacts`. Use for files such as SSL certificates and driver libraries.\n","type":"object","required":["type","edgeArtifactId"],"properties":{"type":{"type":"string","pattern":"^ValueEdgeArtifactId$"},"edgeArtifactId":{"type":"string","format":"uuid","description":"Reference id of the artifact uploaded via `POST /artifacts`."}}},"ValueVaultArtifact":{"title":"VaultArtifactReference","description":"Reference to a vault-stored secret that resolves to a file artifact. Use this instead of `EdgeArtifact` when the file should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultArtifact$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]}}}} ``` ## The ConnectionThoughtSpot object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"ConnectionThoughtSpot":{"type":"object","title":"ThoughtSpot Connection","description":"ThoughtSpot connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionThoughtSpot$","description":"Discriminator for ThoughtSpot connection"},"url":{"description":"ThoughtSpot instance base URL, e.g. https://customer.thoughtspot.cloud","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthThoughtSpot"}},"required":["type","url","auth"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"AuthThoughtSpot":{"title":"ThoughtSpot Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic"}}},"AuthBasic":{"title":"Basic Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthBasic$"},"username":{"description":"Username","$ref":"#/components/schemas/ParameterString"},"password":{"description":"Password","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","username","password"]},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}}}}} ``` ## The AuthAws object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthAws":{"title":"AWS Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthAwsEc2"},{"$ref":"#/components/schemas/AuthAwsIam"}],"discriminator":{"propertyName":"type","mapping":{"AuthAwsEc2":"#/components/schemas/AuthAwsEc2","AuthAwsIam":"#/components/schemas/AuthAwsIam"}}},"AuthAwsEc2":{"title":"AWS EC2 Instance Profile Authentication","type":"object","description":"Authenticate via the IAM role attached to the EC2 instance running the Edge site. No credentials are configured on the connection.","properties":{"type":{"type":"string","pattern":"^AuthAwsEc2$"}},"required":["type"]},"AuthAwsIam":{"title":"AWS IAM Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthAwsIam$"},"awsAccessKeyId":{"description":"AWS Access Key ID","$ref":"#/components/schemas/ParameterString"},"awsSecretKey":{"description":"AWS Secret Access Key","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","awsAccessKeyId","awsSecretKey"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}}}}} ``` ## The AuthAwsEc2 object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthAwsEc2":{"title":"AWS EC2 Instance Profile Authentication","type":"object","description":"Authenticate via the IAM role attached to the EC2 instance running the Edge site. No credentials are configured on the connection.","properties":{"type":{"type":"string","pattern":"^AuthAwsEc2$"}},"required":["type"]}}}} ``` ## The AuthAwsIam object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthAwsIam":{"title":"AWS IAM Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthAwsIam$"},"awsAccessKeyId":{"description":"AWS Access Key ID","$ref":"#/components/schemas/ParameterString"},"awsSecretKey":{"description":"AWS Secret Access Key","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","awsAccessKeyId","awsSecretKey"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}}}}} ``` ## The AuthAzure object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthAzure":{"title":"Azure Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthAzureServicePrincipal"}],"discriminator":{"propertyName":"type","mapping":{"AuthAzureServicePrincipal":"#/components/schemas/AuthAzureServicePrincipal"}}},"AuthAzureServicePrincipal":{"type":"object","title":"Azure Service Principal Authentication","properties":{"type":{"type":"string","pattern":"^AuthAzureServicePrincipal$"},"clientId":{"description":"The ID of the Service Principal used to connect to Azure","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"The Secret Key for the Service Principal","$ref":"#/components/schemas/ParameterSecretString"},"tenantId":{"description":"The Tenant ID of your Azure AD","$ref":"#/components/schemas/ParameterString"}},"required":["type","clientId","clientSecret","tenantId"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}}}}} ``` ## The AuthAzureServicePrincipal object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthAzureServicePrincipal":{"type":"object","title":"Azure Service Principal Authentication","properties":{"type":{"type":"string","pattern":"^AuthAzureServicePrincipal$"},"clientId":{"description":"The ID of the Service Principal used to connect to Azure","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"The Secret Key for the Service Principal","$ref":"#/components/schemas/ParameterSecretString"},"tenantId":{"description":"The Tenant ID of your Azure AD","$ref":"#/components/schemas/ParameterString"}},"required":["type","clientId","clientSecret","tenantId"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}}}}} ``` ## The AuthBasic object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthBasic":{"title":"Basic Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthBasic$"},"username":{"description":"Username","$ref":"#/components/schemas/ParameterString"},"password":{"description":"Password","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","username","password"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}}}}} ``` ## The AuthClientCredentials object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthClientCredentials":{"title":"Client Credentials Authentication","type":"object","description":"Generic client credentials (client ID + secret) authentication, reusable across connection types.","properties":{"type":{"type":"string","pattern":"^AuthClientCredentials$"},"clientId":{"description":"Client ID","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","clientId","clientSecret"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}}}}} ``` ## The AuthClientCredentialsWithTokenUrl object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthClientCredentialsWithTokenUrl":{"title":"Client Credentials with Token URL Authentication","type":"object","description":"OAuth client credentials with token URL (client ID, secret, and token endpoint)","properties":{"type":{"type":"string","pattern":"^AuthClientCredentialsWithTokenUrl$"},"clientId":{"description":"Client ID","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret","$ref":"#/components/schemas/ParameterSecretString"},"tokenUrl":{"description":"The token URL of the OAuth client","$ref":"#/components/schemas/ParameterString"}},"required":["type","clientId","clientSecret","tokenUrl"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}}}}} ``` ## The AuthDatabricks object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthDatabricks":{"title":"Databricks Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthClientCredentials"},{"$ref":"#/components/schemas/AuthDatabricksEntraId"},{"$ref":"#/components/schemas/AuthToken"}],"discriminator":{"propertyName":"type","mapping":{"AuthClientCredentials":"#/components/schemas/AuthClientCredentials","AuthDatabricksEntraId":"#/components/schemas/AuthDatabricksEntraId","AuthToken":"#/components/schemas/AuthToken"}}},"AuthClientCredentials":{"title":"Client Credentials Authentication","type":"object","description":"Generic client credentials (client ID + secret) authentication, reusable across connection types.","properties":{"type":{"type":"string","pattern":"^AuthClientCredentials$"},"clientId":{"description":"Client ID","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","clientId","clientSecret"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}},"AuthDatabricksEntraId":{"title":"Databricks Microsoft Entra ID Authentication","type":"object","description":"Microsoft Entra ID (Azure AD) authentication for Databricks.","properties":{"type":{"type":"string","pattern":"^AuthDatabricksEntraId$"},"clientId":{"description":"Client ID of the Microsoft Entra ID service principal.","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret of the Microsoft Entra ID service principal.","$ref":"#/components/schemas/ParameterSecretString"},"tenantId":{"description":"Tenant ID for Microsoft Entra ID authentication.","$ref":"#/components/schemas/ParameterString"}},"required":["type","clientId","clientSecret","tenantId"]},"AuthToken":{"title":"Token Authentication","type":"object","description":"Generic single-token authentication, reusable across connection types.","properties":{"type":{"type":"string","pattern":"^AuthToken$"},"token":{"description":"Token value for authentication.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","token"]}}}} ``` ## The AuthDatabricksEntraId object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthDatabricksEntraId":{"title":"Databricks Microsoft Entra ID Authentication","type":"object","description":"Microsoft Entra ID (Azure AD) authentication for Databricks.","properties":{"type":{"type":"string","pattern":"^AuthDatabricksEntraId$"},"clientId":{"description":"Client ID of the Microsoft Entra ID service principal.","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret of the Microsoft Entra ID service principal.","$ref":"#/components/schemas/ParameterSecretString"},"tenantId":{"description":"Tenant ID for Microsoft Entra ID authentication.","$ref":"#/components/schemas/ParameterString"}},"required":["type","clientId","clientSecret","tenantId"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}}}}} ``` ## The AuthDbt object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthDbt":{"title":"dbt Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthDbtToken"}],"discriminator":{"propertyName":"type","mapping":{"AuthDbtToken":"#/components/schemas/AuthDbtToken"}}},"AuthDbtToken":{"title":"dbt Token Authentication","type":"object","description":"A dbt Cloud service token with the required permissions, used for authentication.","properties":{"type":{"type":"string","pattern":"^AuthDbtToken$"},"tokenName":{"description":"Name of the service/account token (any unique meaningful name can be used)","$ref":"#/components/schemas/ParameterString"},"tokenValue":{"description":"Value of the service/account token (the copied value from dbt Cloud)","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","tokenName","tokenValue"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}}}}} ``` ## The AuthDbtToken object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthDbtToken":{"title":"dbt Token Authentication","type":"object","description":"A dbt Cloud service token with the required permissions, used for authentication.","properties":{"type":{"type":"string","pattern":"^AuthDbtToken$"},"tokenName":{"description":"Name of the service/account token (any unique meaningful name can be used)","$ref":"#/components/schemas/ParameterString"},"tokenValue":{"description":"Value of the service/account token (the copied value from dbt Cloud)","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","tokenName","tokenValue"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}}}}} ``` ## The AuthGcp object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthGcp":{"title":"GCP Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthGcpServiceAccount"},{"$ref":"#/components/schemas/AuthGcpWif"},{"$ref":"#/components/schemas/AuthGcpWifGke"}],"discriminator":{"propertyName":"type","mapping":{"AuthGcpServiceAccount":"#/components/schemas/AuthGcpServiceAccount","AuthGcpWif":"#/components/schemas/AuthGcpWif","AuthGcpWifGke":"#/components/schemas/AuthGcpWifGke"}}},"AuthGcpServiceAccount":{"title":"GCP Service Account Authentication","type":"object","description":"GCP Service Account authentication (full JSON key)","properties":{"type":{"type":"string","pattern":"^AuthGcpServiceAccount$"},"credentialsJson":{"description":"Full JSON key for the service account","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","credentialsJson"]},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"AuthGcpWif":{"title":"GCP Workload Identity Federation (WIF) Authentication","type":"object","description":"Workload Identity Federation (WIF) - token URL or token","properties":{"type":{"type":"string","pattern":"^AuthGcpWif$"},"tokenOrTokenUrl":{"description":"Token URL or token for WIF","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","tokenOrTokenUrl"]},"AuthGcpWifGke":{"title":"GCP Workload Identity Federation (WIF) using GKE Authentication","type":"object","description":"Workload Identity Federation (WIF) using GKE - credentials from GKE, leave blank","properties":{"type":{"type":"string","pattern":"^AuthGcpWifGke$"}},"required":["type"]}}}} ``` ## The AuthGcpServiceAccount object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthGcpServiceAccount":{"title":"GCP Service Account Authentication","type":"object","description":"GCP Service Account authentication (full JSON key)","properties":{"type":{"type":"string","pattern":"^AuthGcpServiceAccount$"},"credentialsJson":{"description":"Full JSON key for the service account","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","credentialsJson"]},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}}}}} ``` ## The AuthGcpWif object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthGcpWif":{"title":"GCP Workload Identity Federation (WIF) Authentication","type":"object","description":"Workload Identity Federation (WIF) - token URL or token","properties":{"type":{"type":"string","pattern":"^AuthGcpWif$"},"tokenOrTokenUrl":{"description":"Token URL or token for WIF","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","tokenOrTokenUrl"]},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}}}}} ``` ## The AuthGcpWifGke object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthGcpWifGke":{"title":"GCP Workload Identity Federation (WIF) using GKE Authentication","type":"object","description":"Workload Identity Federation (WIF) using GKE - credentials from GKE, leave blank","properties":{"type":{"type":"string","pattern":"^AuthGcpWifGke$"}},"required":["type"]}}}} ``` ## The AuthGit object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthGit":{"title":"Git Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthGitAccessToken"}],"discriminator":{"propertyName":"type","mapping":{"AuthGitAccessToken":"#/components/schemas/AuthGitAccessToken"}}},"AuthGitAccessToken":{"title":"Git Access Token Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthGitAccessToken$"},"username":{"description":"Username for authentication. Required for Bitbucket repositories.","$ref":"#/components/schemas/ParameterString"},"accessToken":{"description":"Personal access token for authenticating with the Git repository.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","accessToken"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}}}}} ``` ## The AuthGitAccessToken object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthGitAccessToken":{"title":"Git Access Token Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthGitAccessToken$"},"username":{"description":"Username for authentication. Required for Bitbucket repositories.","$ref":"#/components/schemas/ParameterString"},"accessToken":{"description":"Personal access token for authenticating with the Git repository.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","accessToken"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}}}}} ``` ## The AuthHttp object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthHttp":{"title":"HTTP Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthNone"},{"$ref":"#/components/schemas/AuthOAuth2"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthNone":"#/components/schemas/AuthNone","AuthOAuth2":"#/components/schemas/AuthOAuth2"}}},"AuthBasic":{"title":"Basic Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthBasic$"},"username":{"description":"Username","$ref":"#/components/schemas/ParameterString"},"password":{"description":"Password","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","username","password"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}},"AuthNone":{"title":"No Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthNone$"}},"required":["type"]},"AuthOAuth2":{"title":"OAuth 2.0 Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthOAuth2$"},"clientId":{"description":"Client id","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret","$ref":"#/components/schemas/ParameterSecretString"},"accessTokenUri":{"description":"Access token URI","$ref":"#/components/schemas/ParameterString"},"scopes":{"description":"Scopes","$ref":"#/components/schemas/ParameterString"}},"required":["type","clientId","clientSecret","accessTokenUri"]}}}} ``` ## The AuthIics object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthIics":{"title":"IICS Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic"}}},"AuthBasic":{"title":"Basic Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthBasic$"},"username":{"description":"Username","$ref":"#/components/schemas/ParameterString"},"password":{"description":"Password","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","username","password"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}}}}} ``` ## The AuthJdbc object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthJdbc":{"title":"JDBC Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthNone"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthNone":"#/components/schemas/AuthNone"}}},"AuthBasic":{"title":"Basic Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthBasic$"},"username":{"description":"Username","$ref":"#/components/schemas/ParameterString"},"password":{"description":"Password","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","username","password"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}},"AuthNone":{"title":"No Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthNone$"}},"required":["type"]}}}} ``` ## The AuthLooker object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthLooker":{"title":"Looker Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthClientCredentials"}],"discriminator":{"propertyName":"type","mapping":{"AuthClientCredentials":"#/components/schemas/AuthClientCredentials"}}},"AuthClientCredentials":{"title":"Client Credentials Authentication","type":"object","description":"Generic client credentials (client ID + secret) authentication, reusable across connection types.","properties":{"type":{"type":"string","pattern":"^AuthClientCredentials$"},"clientId":{"description":"Client ID","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","clientId","clientSecret"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}}}}} ``` ## The AuthMatillion object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthMatillion":{"title":"Matillion Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthToken"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthToken":"#/components/schemas/AuthToken"}}},"AuthBasic":{"title":"Basic Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthBasic$"},"username":{"description":"Username","$ref":"#/components/schemas/ParameterString"},"password":{"description":"Password","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","username","password"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}},"AuthToken":{"title":"Token Authentication","type":"object","description":"Generic single-token authentication, reusable across connection types.","properties":{"type":{"type":"string","pattern":"^AuthToken$"},"token":{"description":"Token value for authentication.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","token"]}}}} ``` ## The AuthMicroStrategy object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthMicroStrategy":{"title":"MicroStrategy Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthToken"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthToken":"#/components/schemas/AuthToken"}}},"AuthBasic":{"title":"Basic Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthBasic$"},"username":{"description":"Username","$ref":"#/components/schemas/ParameterString"},"password":{"description":"Password","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","username","password"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}},"AuthToken":{"title":"Token Authentication","type":"object","description":"Generic single-token authentication, reusable across connection types.","properties":{"type":{"type":"string","pattern":"^AuthToken$"},"token":{"description":"Token value for authentication.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","token"]}}}} ``` ## The AuthMlflow object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthMlflow":{"title":"MLflow Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthClientCredentialsWithTokenUrl"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthClientCredentialsWithTokenUrl":"#/components/schemas/AuthClientCredentialsWithTokenUrl"}}},"AuthBasic":{"title":"Basic Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthBasic$"},"username":{"description":"Username","$ref":"#/components/schemas/ParameterString"},"password":{"description":"Password","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","username","password"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}},"AuthClientCredentialsWithTokenUrl":{"title":"Client Credentials with Token URL Authentication","type":"object","description":"OAuth client credentials with token URL (client ID, secret, and token endpoint)","properties":{"type":{"type":"string","pattern":"^AuthClientCredentialsWithTokenUrl$"},"clientId":{"description":"Client ID","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret","$ref":"#/components/schemas/ParameterSecretString"},"tokenUrl":{"description":"The token URL of the OAuth client","$ref":"#/components/schemas/ParameterString"}},"required":["type","clientId","clientSecret","tokenUrl"]}}}} ``` ## The AuthNone object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthNone":{"title":"No Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthNone$"}},"required":["type"]}}}} ``` ## The AuthOAuth2 object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthOAuth2":{"title":"OAuth 2.0 Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthOAuth2$"},"clientId":{"description":"Client id","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret","$ref":"#/components/schemas/ParameterSecretString"},"accessTokenUri":{"description":"Access token URI","$ref":"#/components/schemas/ParameterString"},"scopes":{"description":"Scopes","$ref":"#/components/schemas/ParameterString"}},"required":["type","clientId","clientSecret","accessTokenUri"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}}}}} ``` ## The AuthPowerBI object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthPowerBI":{"title":"Power BI Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthPowerBIResourceOwnerPassword"},{"$ref":"#/components/schemas/AuthPowerBIServicePrincipal"}],"discriminator":{"propertyName":"type","mapping":{"AuthPowerBIResourceOwnerPassword":"#/components/schemas/AuthPowerBIResourceOwnerPassword","AuthPowerBIServicePrincipal":"#/components/schemas/AuthPowerBIServicePrincipal"}}},"AuthPowerBIResourceOwnerPassword":{"title":"Power BI Resource Owner Password Credentials Authentication","type":"object","description":"Resource Owner Password Credentials authentication for Power BI","properties":{"type":{"type":"string","pattern":"^AuthPowerBIResourceOwnerPassword$"},"applicationId":{"description":"Application ID","$ref":"#/components/schemas/ParameterString"},"username":{"description":"Username","$ref":"#/components/schemas/ParameterString"},"passwordSecretKey":{"description":"Password/Secret key","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","applicationId","username","passwordSecretKey"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}},"AuthPowerBIServicePrincipal":{"title":"Power BI Service Principal Authentication","type":"object","description":"Service Principal authentication for Power BI","properties":{"type":{"type":"string","pattern":"^AuthPowerBIServicePrincipal$"},"applicationId":{"description":"Application ID","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret for the service principal","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","applicationId","clientSecret"]}}}} ``` ## The AuthPowerBIResourceOwnerPassword object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthPowerBIResourceOwnerPassword":{"title":"Power BI Resource Owner Password Credentials Authentication","type":"object","description":"Resource Owner Password Credentials authentication for Power BI","properties":{"type":{"type":"string","pattern":"^AuthPowerBIResourceOwnerPassword$"},"applicationId":{"description":"Application ID","$ref":"#/components/schemas/ParameterString"},"username":{"description":"Username","$ref":"#/components/schemas/ParameterString"},"passwordSecretKey":{"description":"Password/Secret key","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","applicationId","username","passwordSecretKey"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}}}}} ``` ## The AuthPowerBIServicePrincipal object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthPowerBIServicePrincipal":{"title":"Power BI Service Principal Authentication","type":"object","description":"Service Principal authentication for Power BI","properties":{"type":{"type":"string","pattern":"^AuthPowerBIServicePrincipal$"},"applicationId":{"description":"Application ID","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret for the service principal","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","applicationId","clientSecret"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}}}}} ``` ## The AuthS3Compatible object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthS3Compatible":{"title":"S3-Compatible Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthS3CompatibleAccessKey"}],"discriminator":{"propertyName":"type","mapping":{"AuthS3CompatibleAccessKey":"#/components/schemas/AuthS3CompatibleAccessKey"}}},"AuthS3CompatibleAccessKey":{"title":"S3-Compatible Access Key Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthS3CompatibleAccessKey$"},"accessKeyId":{"description":"Access key ID for the S3-compatible storage service.","$ref":"#/components/schemas/ParameterString"},"secretAccessKey":{"description":"Secret access key for the S3-compatible storage service.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","accessKeyId","secretAccessKey"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}}}}} ``` ## The AuthS3CompatibleAccessKey object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthS3CompatibleAccessKey":{"title":"S3-Compatible Access Key Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthS3CompatibleAccessKey$"},"accessKeyId":{"description":"Access key ID for the S3-compatible storage service.","$ref":"#/components/schemas/ParameterString"},"secretAccessKey":{"description":"Secret access key for the S3-compatible storage service.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","accessKeyId","secretAccessKey"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}}}}} ``` ## The AuthSapAICore object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthSapAICore":{"title":"SAP AI Core Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthClientCredentialsWithTokenUrl"}],"discriminator":{"propertyName":"type","mapping":{"AuthClientCredentialsWithTokenUrl":"#/components/schemas/AuthClientCredentialsWithTokenUrl"}}},"AuthClientCredentialsWithTokenUrl":{"title":"Client Credentials with Token URL Authentication","type":"object","description":"OAuth client credentials with token URL (client ID, secret, and token endpoint)","properties":{"type":{"type":"string","pattern":"^AuthClientCredentialsWithTokenUrl$"},"clientId":{"description":"Client ID","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret","$ref":"#/components/schemas/ParameterSecretString"},"tokenUrl":{"description":"The token URL of the OAuth client","$ref":"#/components/schemas/ParameterString"}},"required":["type","clientId","clientSecret","tokenUrl"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}}}}} ``` ## The AuthSapDatasphereCatalog object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthSapDatasphereCatalog":{"title":"SAP Datasphere Catalog Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthClientCredentialsWithTokenUrl"}],"discriminator":{"propertyName":"type","mapping":{"AuthClientCredentialsWithTokenUrl":"#/components/schemas/AuthClientCredentialsWithTokenUrl"}}},"AuthClientCredentialsWithTokenUrl":{"title":"Client Credentials with Token URL Authentication","type":"object","description":"OAuth client credentials with token URL (client ID, secret, and token endpoint)","properties":{"type":{"type":"string","pattern":"^AuthClientCredentialsWithTokenUrl$"},"clientId":{"description":"Client ID","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret","$ref":"#/components/schemas/ParameterSecretString"},"tokenUrl":{"description":"The token URL of the OAuth client","$ref":"#/components/schemas/ParameterString"}},"required":["type","clientId","clientSecret","tokenUrl"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}}}}} ``` ## The AuthSigma object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthSigma":{"title":"Sigma Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthClientCredentials"}],"discriminator":{"propertyName":"type","mapping":{"AuthClientCredentials":"#/components/schemas/AuthClientCredentials"}}},"AuthClientCredentials":{"title":"Client Credentials Authentication","type":"object","description":"Generic client credentials (client ID + secret) authentication, reusable across connection types.","properties":{"type":{"type":"string","pattern":"^AuthClientCredentials$"},"clientId":{"description":"Client ID","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","clientId","clientSecret"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}}}}} ``` ## The AuthSnowflake object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthSnowflake":{"title":"Snowflake Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthSnowflakeKeyPair"},{"$ref":"#/components/schemas/AuthSnowflakePat"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthSnowflakeKeyPair":"#/components/schemas/AuthSnowflakeKeyPair","AuthSnowflakePat":"#/components/schemas/AuthSnowflakePat"}}},"AuthBasic":{"title":"Basic Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthBasic$"},"username":{"description":"Username","$ref":"#/components/schemas/ParameterString"},"password":{"description":"Password","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","username","password"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}},"AuthSnowflakeKeyPair":{"title":"Snowflake Key Pair Authentication","type":"object","description":"Key pair authentication for Snowflake.","properties":{"type":{"type":"string","pattern":"^AuthSnowflakeKeyPair$"},"username":{"description":"The username to authenticate against the Snowflake account.","$ref":"#/components/schemas/ParameterString"},"privateKeyEdgeArtifact":{"description":"The private key artifact in P8 format for key pair authentication.","$ref":"#/components/schemas/ParameterSecretEdgeArtifact"},"privateKeyPwd":{"description":"The passphrase for the private key, if it is encrypted.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","username","privateKeyEdgeArtifact"]},"ParameterSecretEdgeArtifact":{"description":"References a sensitive artifact stored on the Edge site. The file content never leaves the Edge site cluster. Use for private keys and other sensitive artifacts.\n","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueSecretEdgeArtifactId"},{"$ref":"#/components/schemas/ValueVaultArtifact"}],"discriminator":{"propertyName":"type","mapping":{"ValueSecretEdgeArtifactId":"#/components/schemas/ValueSecretEdgeArtifactId","ValueVaultArtifact":"#/components/schemas/ValueVaultArtifact"}}},"ValueSecretEdgeArtifactId":{"title":"Secret Edge Artifact ID","description":"References a secret artifact stored on the Edge site and uploaded via `POST /sites/{siteId}/secretArtifacts`. The file content never leaves the Edge site cluster. Use for private keys and other sensitive artifacts. Each secret artifact can only be referenced by a single connection and cannot be reused.\n","type":"object","required":["type","secretEdgeArtifactId"],"properties":{"type":{"type":"string","pattern":"^ValueSecretEdgeArtifactId$"},"secretEdgeArtifactId":{"type":"string","maxLength":512,"description":"The `id` value returned by `POST /sites/{siteId}/secretArtifacts`.\n"}}},"ValueVaultArtifact":{"title":"VaultArtifactReference","description":"Reference to a vault-stored secret that resolves to a file artifact. Use this instead of `EdgeArtifact` when the file should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultArtifact$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"AuthSnowflakePat":{"title":"Snowflake Programmatic Access Token Authentication","type":"object","description":"Programmatic Access Token (PAT) authentication for Snowflake.","properties":{"type":{"type":"string","pattern":"^AuthSnowflakePat$"},"programmaticAccessToken":{"description":"Programmatic Access Token generated in Snowflake.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","programmaticAccessToken"]}}}} ``` ## The AuthSnowflakeKeyPair object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthSnowflakeKeyPair":{"title":"Snowflake Key Pair Authentication","type":"object","description":"Key pair authentication for Snowflake.","properties":{"type":{"type":"string","pattern":"^AuthSnowflakeKeyPair$"},"username":{"description":"The username to authenticate against the Snowflake account.","$ref":"#/components/schemas/ParameterString"},"privateKeyEdgeArtifact":{"description":"The private key artifact in P8 format for key pair authentication.","$ref":"#/components/schemas/ParameterSecretEdgeArtifact"},"privateKeyPwd":{"description":"The passphrase for the private key, if it is encrypted.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","username","privateKeyEdgeArtifact"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ParameterSecretEdgeArtifact":{"description":"References a sensitive artifact stored on the Edge site. The file content never leaves the Edge site cluster. Use for private keys and other sensitive artifacts.\n","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueSecretEdgeArtifactId"},{"$ref":"#/components/schemas/ValueVaultArtifact"}],"discriminator":{"propertyName":"type","mapping":{"ValueSecretEdgeArtifactId":"#/components/schemas/ValueSecretEdgeArtifactId","ValueVaultArtifact":"#/components/schemas/ValueVaultArtifact"}}},"ValueSecretEdgeArtifactId":{"title":"Secret Edge Artifact ID","description":"References a secret artifact stored on the Edge site and uploaded via `POST /sites/{siteId}/secretArtifacts`. The file content never leaves the Edge site cluster. Use for private keys and other sensitive artifacts. Each secret artifact can only be referenced by a single connection and cannot be reused.\n","type":"object","required":["type","secretEdgeArtifactId"],"properties":{"type":{"type":"string","pattern":"^ValueSecretEdgeArtifactId$"},"secretEdgeArtifactId":{"type":"string","maxLength":512,"description":"The `id` value returned by `POST /sites/{siteId}/secretArtifacts`.\n"}}},"ValueVaultArtifact":{"title":"VaultArtifactReference","description":"Reference to a vault-stored secret that resolves to a file artifact. Use this instead of `EdgeArtifact` when the file should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultArtifact$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}}}}} ``` ## The AuthSnowflakePat object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthSnowflakePat":{"title":"Snowflake Programmatic Access Token Authentication","type":"object","description":"Programmatic Access Token (PAT) authentication for Snowflake.","properties":{"type":{"type":"string","pattern":"^AuthSnowflakePat$"},"programmaticAccessToken":{"description":"Programmatic Access Token generated in Snowflake.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","programmaticAccessToken"]},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}}}}} ``` ## The AuthSsrs object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthSsrs":{"title":"SSRS Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic"}}},"AuthBasic":{"title":"Basic Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthBasic$"},"username":{"description":"Username","$ref":"#/components/schemas/ParameterString"},"password":{"description":"Password","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","username","password"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}}}}} ``` ## The AuthTableau object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthTableau":{"title":"Tableau Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthTableauToken"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthTableauToken":"#/components/schemas/AuthTableauToken"}}},"AuthBasic":{"title":"Basic Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthBasic$"},"username":{"description":"Username","$ref":"#/components/schemas/ParameterString"},"password":{"description":"Password","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","username","password"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}},"AuthTableauToken":{"title":"Tableau Token Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthTableauToken$"},"tokenName":{"description":"Name of the service/account token (any unique meaningful name can be used)","$ref":"#/components/schemas/ParameterString"},"tokenSecret":{"description":"Value of the service/account token","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","tokenName","tokenSecret"]}}}} ``` ## The AuthTableauToken object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthTableauToken":{"title":"Tableau Token Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthTableauToken$"},"tokenName":{"description":"Name of the service/account token (any unique meaningful name can be used)","$ref":"#/components/schemas/ParameterString"},"tokenSecret":{"description":"Value of the service/account token","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","tokenName","tokenSecret"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}}}}} ``` ## The AuthThoughtSpot object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthThoughtSpot":{"title":"ThoughtSpot Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic"}}},"AuthBasic":{"title":"Basic Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthBasic$"},"username":{"description":"Username","$ref":"#/components/schemas/ParameterString"},"password":{"description":"Password","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","username","password"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}}}}} ``` ## The AuthToken object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"AuthToken":{"title":"Token Authentication","type":"object","description":"Generic single-token authentication, reusable across connection types.","properties":{"type":{"type":"string","pattern":"^AuthToken$"},"token":{"description":"Token value for authentication.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","token"]},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}}}}} ``` ## The ConnectionCreate object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"ConnectionCreate":{"type":"object","properties":{"name":{"type":"string","pattern":"^[a-zA-Z0-9_.-]+$","maxLength":255},"description":{"type":"string","maxLength":4000},"vaultId":{"type":"string","format":"uuid","description":"Associated vault id, if configured"},"properties":{"$ref":"#/components/schemas/ConnectionProperties"}},"required":["name","properties"],"description":"Request body for creating a data source connection."},"ConnectionProperties":{"oneOf":[{"$ref":"#/components/schemas/ConnectionAws"},{"$ref":"#/components/schemas/ConnectionAzure"},{"$ref":"#/components/schemas/ConnectionDatabricks"},{"$ref":"#/components/schemas/ConnectionDbt"},{"$ref":"#/components/schemas/ConnectionGcp"},{"$ref":"#/components/schemas/ConnectionGit"},{"$ref":"#/components/schemas/ConnectionHttp"},{"$ref":"#/components/schemas/ConnectionIics"},{"$ref":"#/components/schemas/ConnectionJdbc"},{"$ref":"#/components/schemas/ConnectionLocalStorage"},{"$ref":"#/components/schemas/ConnectionLooker"},{"$ref":"#/components/schemas/ConnectionMatillion"},{"$ref":"#/components/schemas/ConnectionMicroStrategy"},{"$ref":"#/components/schemas/ConnectionMlflow"},{"$ref":"#/components/schemas/ConnectionPowerBI"},{"$ref":"#/components/schemas/ConnectionS3Compatible"},{"$ref":"#/components/schemas/ConnectionSapAICore"},{"$ref":"#/components/schemas/ConnectionSapDatasphereCatalog"},{"$ref":"#/components/schemas/ConnectionSigma"},{"$ref":"#/components/schemas/ConnectionSnowflake"},{"$ref":"#/components/schemas/ConnectionSsrs"},{"$ref":"#/components/schemas/ConnectionTableau"},{"$ref":"#/components/schemas/ConnectionThoughtSpot"}],"discriminator":{"propertyName":"type","mapping":{"ConnectionAws":"#/components/schemas/ConnectionAws","ConnectionAzure":"#/components/schemas/ConnectionAzure","ConnectionDatabricks":"#/components/schemas/ConnectionDatabricks","ConnectionDbt":"#/components/schemas/ConnectionDbt","ConnectionGcp":"#/components/schemas/ConnectionGcp","ConnectionGit":"#/components/schemas/ConnectionGit","ConnectionHttp":"#/components/schemas/ConnectionHttp","ConnectionIics":"#/components/schemas/ConnectionIics","ConnectionJdbc":"#/components/schemas/ConnectionJdbc","ConnectionLocalStorage":"#/components/schemas/ConnectionLocalStorage","ConnectionLooker":"#/components/schemas/ConnectionLooker","ConnectionMatillion":"#/components/schemas/ConnectionMatillion","ConnectionMicroStrategy":"#/components/schemas/ConnectionMicroStrategy","ConnectionMlflow":"#/components/schemas/ConnectionMlflow","ConnectionPowerBI":"#/components/schemas/ConnectionPowerBI","ConnectionS3Compatible":"#/components/schemas/ConnectionS3Compatible","ConnectionSapAICore":"#/components/schemas/ConnectionSapAICore","ConnectionSapDatasphereCatalog":"#/components/schemas/ConnectionSapDatasphereCatalog","ConnectionSigma":"#/components/schemas/ConnectionSigma","ConnectionSnowflake":"#/components/schemas/ConnectionSnowflake","ConnectionSsrs":"#/components/schemas/ConnectionSsrs","ConnectionTableau":"#/components/schemas/ConnectionTableau","ConnectionThoughtSpot":"#/components/schemas/ConnectionThoughtSpot"}}},"ConnectionAws":{"type":"object","title":"AWS Connection","description":"AWS connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionAws$","description":"Discriminator for AWS connection"},"auth":{"$ref":"#/components/schemas/AuthAws"},"parameters":{"$ref":"#/components/schemas/ParameterGenericMap"}},"required":["type","auth"]},"AuthAws":{"title":"AWS Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthAwsEc2"},{"$ref":"#/components/schemas/AuthAwsIam"}],"discriminator":{"propertyName":"type","mapping":{"AuthAwsEc2":"#/components/schemas/AuthAwsEc2","AuthAwsIam":"#/components/schemas/AuthAwsIam"}}},"AuthAwsEc2":{"title":"AWS EC2 Instance Profile Authentication","type":"object","description":"Authenticate via the IAM role attached to the EC2 instance running the Edge site. No credentials are configured on the connection.","properties":{"type":{"type":"string","pattern":"^AuthAwsEc2$"}},"required":["type"]},"AuthAwsIam":{"title":"AWS IAM Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthAwsIam$"},"awsAccessKeyId":{"description":"AWS Access Key ID","$ref":"#/components/schemas/ParameterString"},"awsSecretKey":{"description":"AWS Secret Access Key","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","awsAccessKeyId","awsSecretKey"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}},"ParameterGenericMap":{"type":"object","description":"Map of parameters for connections used to pass additional configuration.","additionalProperties":{"$ref":"#/components/schemas/ParameterGeneric"}},"ParameterGeneric":{"title":"Generic Parameter","description":"A parameter value for use in a data source connection parameter configuration.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueEdgeArtifactId"},{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueSecretEdgeArtifactId"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultArtifact"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueEdgeArtifactId":"#/components/schemas/ValueEdgeArtifactId","ValueRedacted":"#/components/schemas/ValueRedacted","ValueSecretEdgeArtifactId":"#/components/schemas/ValueSecretEdgeArtifactId","ValueString":"#/components/schemas/ValueString","ValueVaultArtifact":"#/components/schemas/ValueVaultArtifact","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueEdgeArtifactId":{"title":"Edge Artifact ID","description":"References a non-sensitive artifact stored on the Collibra instance and uploaded via `POST /artifacts`. Use for files such as SSL certificates and driver libraries.\n","type":"object","required":["type","edgeArtifactId"],"properties":{"type":{"type":"string","pattern":"^ValueEdgeArtifactId$"},"edgeArtifactId":{"type":"string","format":"uuid","description":"Reference id of the artifact uploaded via `POST /artifacts`."}}},"ValueSecretEdgeArtifactId":{"title":"Secret Edge Artifact ID","description":"References a secret artifact stored on the Edge site and uploaded via `POST /sites/{siteId}/secretArtifacts`. The file content never leaves the Edge site cluster. Use for private keys and other sensitive artifacts. Each secret artifact can only be referenced by a single connection and cannot be reused.\n","type":"object","required":["type","secretEdgeArtifactId"],"properties":{"type":{"type":"string","pattern":"^ValueSecretEdgeArtifactId$"},"secretEdgeArtifactId":{"type":"string","maxLength":512,"description":"The `id` value returned by `POST /sites/{siteId}/secretArtifacts`.\n"}}},"ValueVaultArtifact":{"title":"VaultArtifactReference","description":"Reference to a vault-stored secret that resolves to a file artifact. Use this instead of `EdgeArtifact` when the file should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultArtifact$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"ConnectionAzure":{"type":"object","title":"Azure Connection","description":"Azure connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionAzure$","description":"Discriminator for Azure connection"},"usGovernmentCloudHost":{"description":"Indicates whether Azure US Government Cloud is the host for Microsoft Entra.","type":"boolean","default":false},"auth":{"$ref":"#/components/schemas/AuthAzure"}},"required":["type","auth"]},"AuthAzure":{"title":"Azure Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthAzureServicePrincipal"}],"discriminator":{"propertyName":"type","mapping":{"AuthAzureServicePrincipal":"#/components/schemas/AuthAzureServicePrincipal"}}},"AuthAzureServicePrincipal":{"type":"object","title":"Azure Service Principal Authentication","properties":{"type":{"type":"string","pattern":"^AuthAzureServicePrincipal$"},"clientId":{"description":"The ID of the Service Principal used to connect to Azure","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"The Secret Key for the Service Principal","$ref":"#/components/schemas/ParameterSecretString"},"tenantId":{"description":"The Tenant ID of your Azure AD","$ref":"#/components/schemas/ParameterString"}},"required":["type","clientId","clientSecret","tenantId"]},"ConnectionDatabricks":{"type":"object","title":"Databricks Connection","description":"Databricks connection.","properties":{"type":{"type":"string","pattern":"^ConnectionDatabricks$","description":"Discriminator for Databricks connection."},"workspaceUrl":{"description":"Workspace URL on Databricks.","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthDatabricks"}},"required":["type","workspaceUrl","auth"]},"AuthDatabricks":{"title":"Databricks Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthClientCredentials"},{"$ref":"#/components/schemas/AuthDatabricksEntraId"},{"$ref":"#/components/schemas/AuthToken"}],"discriminator":{"propertyName":"type","mapping":{"AuthClientCredentials":"#/components/schemas/AuthClientCredentials","AuthDatabricksEntraId":"#/components/schemas/AuthDatabricksEntraId","AuthToken":"#/components/schemas/AuthToken"}}},"AuthClientCredentials":{"title":"Client Credentials Authentication","type":"object","description":"Generic client credentials (client ID + secret) authentication, reusable across connection types.","properties":{"type":{"type":"string","pattern":"^AuthClientCredentials$"},"clientId":{"description":"Client ID","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","clientId","clientSecret"]},"AuthDatabricksEntraId":{"title":"Databricks Microsoft Entra ID Authentication","type":"object","description":"Microsoft Entra ID (Azure AD) authentication for Databricks.","properties":{"type":{"type":"string","pattern":"^AuthDatabricksEntraId$"},"clientId":{"description":"Client ID of the Microsoft Entra ID service principal.","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret of the Microsoft Entra ID service principal.","$ref":"#/components/schemas/ParameterSecretString"},"tenantId":{"description":"Tenant ID for Microsoft Entra ID authentication.","$ref":"#/components/schemas/ParameterString"}},"required":["type","clientId","clientSecret","tenantId"]},"AuthToken":{"title":"Token Authentication","type":"object","description":"Generic single-token authentication, reusable across connection types.","properties":{"type":{"type":"string","pattern":"^AuthToken$"},"token":{"description":"Token value for authentication.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","token"]},"ConnectionDbt":{"type":"object","title":"dbt Connection","description":"dbt connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionDbt$","description":"Discriminator for dbt Connection"},"adminUrl":{"description":"Optional dbt admin API URL. Defaults to https://cloud.getdbt.com/api/v2","$ref":"#/components/schemas/ParameterString"},"metadataUrl":{"description":"Optional dbt metadata URL. Defaults to https://metadata.cloud.getdbt.com/graphql","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthDbt"}},"required":["type","auth"]},"AuthDbt":{"title":"dbt Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthDbtToken"}],"discriminator":{"propertyName":"type","mapping":{"AuthDbtToken":"#/components/schemas/AuthDbtToken"}}},"AuthDbtToken":{"title":"dbt Token Authentication","type":"object","description":"A dbt Cloud service token with the required permissions, used for authentication.","properties":{"type":{"type":"string","pattern":"^AuthDbtToken$"},"tokenName":{"description":"Name of the service/account token (any unique meaningful name can be used)","$ref":"#/components/schemas/ParameterString"},"tokenValue":{"description":"Value of the service/account token (the copied value from dbt Cloud)","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","tokenName","tokenValue"]},"ConnectionGcp":{"type":"object","title":"GCP Connection","description":"GCP connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionGcp$","description":"Discriminator for GCP Connection"},"auth":{"$ref":"#/components/schemas/AuthGcp"},"parameters":{"$ref":"#/components/schemas/ParameterGenericMap"}},"required":["type","auth"]},"AuthGcp":{"title":"GCP Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthGcpServiceAccount"},{"$ref":"#/components/schemas/AuthGcpWif"},{"$ref":"#/components/schemas/AuthGcpWifGke"}],"discriminator":{"propertyName":"type","mapping":{"AuthGcpServiceAccount":"#/components/schemas/AuthGcpServiceAccount","AuthGcpWif":"#/components/schemas/AuthGcpWif","AuthGcpWifGke":"#/components/schemas/AuthGcpWifGke"}}},"AuthGcpServiceAccount":{"title":"GCP Service Account Authentication","type":"object","description":"GCP Service Account authentication (full JSON key)","properties":{"type":{"type":"string","pattern":"^AuthGcpServiceAccount$"},"credentialsJson":{"description":"Full JSON key for the service account","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","credentialsJson"]},"AuthGcpWif":{"title":"GCP Workload Identity Federation (WIF) Authentication","type":"object","description":"Workload Identity Federation (WIF) - token URL or token","properties":{"type":{"type":"string","pattern":"^AuthGcpWif$"},"tokenOrTokenUrl":{"description":"Token URL or token for WIF","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","tokenOrTokenUrl"]},"AuthGcpWifGke":{"title":"GCP Workload Identity Federation (WIF) using GKE Authentication","type":"object","description":"Workload Identity Federation (WIF) using GKE - credentials from GKE, leave blank","properties":{"type":{"type":"string","pattern":"^AuthGcpWifGke$"}},"required":["type"]},"ConnectionGit":{"type":"object","title":"Git Connection","description":"Connection to a Git repository\n","properties":{"type":{"type":"string","pattern":"^ConnectionGit$","description":"Discriminator for Git connection"},"repositoryUrl":{"description":"HTTPS URL of the Git repository root, e.g. https://github.com/org/repo.git","$ref":"#/components/schemas/ParameterString"},"subfolder":{"description":"Path to a specific subfolder within the repository, e.g. src or projects/analytics.","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthGit"}},"required":["type","repositoryUrl","auth"]},"AuthGit":{"title":"Git Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthGitAccessToken"}],"discriminator":{"propertyName":"type","mapping":{"AuthGitAccessToken":"#/components/schemas/AuthGitAccessToken"}}},"AuthGitAccessToken":{"title":"Git Access Token Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthGitAccessToken$"},"username":{"description":"Username for authentication. Required for Bitbucket repositories.","$ref":"#/components/schemas/ParameterString"},"accessToken":{"description":"Personal access token for authenticating with the Git repository.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","accessToken"]},"ConnectionHttp":{"type":"object","title":"HTTP Connection","description":"Allows workflows to communicate with other HTTP based systems.\n","properties":{"type":{"type":"string","pattern":"^ConnectionHttp$","description":"Discriminator for HTTP connection"},"host":{"description":"The protocol and domain name of the server to connect to, for example, https://api.example.com","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthHttp"},"testConnectionPath":{"description":"The path for testing this connection with a GET call, for example, /v1/health.","$ref":"#/components/schemas/ParameterString"}},"required":["type","host"]},"AuthHttp":{"title":"HTTP Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthNone"},{"$ref":"#/components/schemas/AuthOAuth2"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthNone":"#/components/schemas/AuthNone","AuthOAuth2":"#/components/schemas/AuthOAuth2"}}},"AuthBasic":{"title":"Basic Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthBasic$"},"username":{"description":"Username","$ref":"#/components/schemas/ParameterString"},"password":{"description":"Password","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","username","password"]},"AuthNone":{"title":"No Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthNone$"}},"required":["type"]},"AuthOAuth2":{"title":"OAuth 2.0 Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthOAuth2$"},"clientId":{"description":"Client id","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret","$ref":"#/components/schemas/ParameterSecretString"},"accessTokenUri":{"description":"Access token URI","$ref":"#/components/schemas/ParameterString"},"scopes":{"description":"Scopes","$ref":"#/components/schemas/ParameterString"}},"required":["type","clientId","clientSecret","accessTokenUri"]},"ConnectionIics":{"type":"object","title":"Informatica Intelligent Cloud Services (IICS) Connection","description":"IICS connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionIics$","description":"Discriminator for Informatica Intelligent Cloud Services (IICS) Connection"},"url":{"description":"IICS Url","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthIics"}},"required":["type","url","auth"]},"AuthIics":{"title":"IICS Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic"}}},"ConnectionJdbc":{"title":"JDBC Connection","type":"object","required":["type","driver","connectionString"],"properties":{"type":{"type":"string","pattern":"^ConnectionJdbc$","description":"Discriminator for JDBC connection types."},"driver":{"$ref":"#/components/schemas/JdbcDriver"},"connectionString":{"$ref":"#/components/schemas/ParameterString","description":"JDBC connection string, e.g. \"jdbc:mysql://localhost:3306/mydb\""},"auth":{"description":"Authentication configuration. When omitted, defaults to AuthNone.","$ref":"#/components/schemas/AuthJdbc"},"parameters":{"description":"Additional JDBC connection properties, such as SSL settings, timeouts, etc. These are passed as key-value pairs in the connection string.","allOf":[{"$ref":"#/components/schemas/ParameterGenericMap"}]}}},"JdbcDriver":{"type":"object","description":"JDBC driver configuration (`JdbcDriverDirect`). Specify the driver jar, an optional classpath, and the fully qualified driver class name.","oneOf":[{"$ref":"#/components/schemas/JdbcDriverDirect"}],"discriminator":{"propertyName":"type","mapping":{"JdbcDriverDirect":"#/components/schemas/JdbcDriverDirect"}}},"JdbcDriverDirect":{"title":"Direct JDBC Driver","type":"object","properties":{"type":{"type":"string","pattern":"^JdbcDriverDirect$"},"className":{"type":"string","description":"Fully qualified class name of the JDBC driver (e.g. \"org.postgresql.Driver\", \"com.mysql.cj.jdbc.Driver\", etc.).","maxLength":100,"pattern":"^[a-zA-Z0-9._$]+$"},"jar":{"type":"string","format":"uuid","description":"Reference id of the driver jar uploaded via `POST /drivers/jars`."},"additionalClasspathFiles":{"type":"array","maxItems":10,"items":{"type":"string","format":"uuid","description":"Reference id of a driver jar or native library uploaded via `POST /drivers/jars` or `POST /drivers/nativeLibs`."}}},"required":["className","type","jar"],"description":"This schema contains the allowed configuration files that can be uploaded to set up a JDBC connection type."},"AuthJdbc":{"title":"JDBC Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthNone"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthNone":"#/components/schemas/AuthNone"}}},"ConnectionLocalStorage":{"type":"object","title":"Shared Storage Connection","description":"Read-only access to a folder located on the Edge site. Used for technical lineage ingestion via OpenLineage (AWS Glue, Apache Airflow, OpenLineage).\n","properties":{"type":{"type":"string","pattern":"^ConnectionLocalStorage$","description":"Discriminator for shared storage connection"},"folder":{"description":"--target as specified in ./edgecli object folder-upload","type":"string","pattern":"^[\\w-]+$"}},"required":["type","folder"]},"ConnectionLooker":{"type":"object","title":"Looker Connection","description":"Looker connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionLooker$","description":"Discriminator for Looker Connection"},"url":{"description":"Looker URL","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthLooker"}},"required":["type","url","auth"]},"AuthLooker":{"title":"Looker Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthClientCredentials"}],"discriminator":{"propertyName":"type","mapping":{"AuthClientCredentials":"#/components/schemas/AuthClientCredentials"}}},"ConnectionMatillion":{"type":"object","title":"Matillion Connection","description":"Matillion connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionMatillion$","description":"Discriminator for Matillion Connection"},"url":{"description":"Matillion Url","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthMatillion"},"certFile":{"description":"Custom certificate","$ref":"#/components/schemas/ParameterEdgeArtifact"}},"required":["type","url","auth"]},"AuthMatillion":{"title":"Matillion Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthToken"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthToken":"#/components/schemas/AuthToken"}}},"ParameterEdgeArtifact":{"description":"References a non-sensitive artifact stored on the customer's Collibra Platform instance. Use for SSL certificates, driver libraries, and other files that do not need to stay within the customer's Edge site.\n","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueEdgeArtifactId"},{"$ref":"#/components/schemas/ValueVaultArtifact"}],"discriminator":{"propertyName":"type","mapping":{"ValueEdgeArtifactId":"#/components/schemas/ValueEdgeArtifactId","ValueVaultArtifact":"#/components/schemas/ValueVaultArtifact"}}},"ConnectionMicroStrategy":{"type":"object","title":"MicroStrategy Connection","description":"MicroStrategy connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionMicroStrategy$","description":"Discriminator for MicroStrategy Connection"},"url":{"description":"MicroStrategy URL","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthMicroStrategy"}},"required":["type","url","auth"]},"AuthMicroStrategy":{"title":"MicroStrategy Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthToken"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthToken":"#/components/schemas/AuthToken"}}},"ConnectionMlflow":{"type":"object","title":"MLflow Connection","description":"MLflow connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionMlflow$","description":"Discriminator for MLflow connection"},"url":{"description":"MLflow URL","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthMlflow"}},"required":["type","url","auth"]},"AuthMlflow":{"title":"MLflow Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthClientCredentialsWithTokenUrl"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthClientCredentialsWithTokenUrl":"#/components/schemas/AuthClientCredentialsWithTokenUrl"}}},"AuthClientCredentialsWithTokenUrl":{"title":"Client Credentials with Token URL Authentication","type":"object","description":"OAuth client credentials with token URL (client ID, secret, and token endpoint)","properties":{"type":{"type":"string","pattern":"^AuthClientCredentialsWithTokenUrl$"},"clientId":{"description":"Client ID","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret","$ref":"#/components/schemas/ParameterSecretString"},"tokenUrl":{"description":"The token URL of the OAuth client","$ref":"#/components/schemas/ParameterString"}},"required":["type","clientId","clientSecret","tokenUrl"]},"ConnectionPowerBI":{"type":"object","title":"Power BI Connection","description":"Power BI (SaaS) connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionPowerBI$","description":"Discriminator for Power BI Connection"},"tenantDomain":{"description":"Tenant Domain","$ref":"#/components/schemas/ParameterString"},"auth":{"description":"Authentication configuration for Power BI. Supports ServicePrincipal and ResourceOwnerPassword flows.\n","$ref":"#/components/schemas/AuthPowerBI"},"certFile":{"description":"Optional custom SSL/TLS certificate, in PEM format, used to establish a trusted HTTPS connection to the Power BI service. Provide this when the connection is routed through a proxy or gateway that presents a certificate signed by a custom or private Certificate Authority that is not trusted by default. The certificate is referenced as a non-sensitive artifact stored on the customer's Collibra Platform instance. When omitted, the system's default trusted CAs are used.\n","$ref":"#/components/schemas/ParameterEdgeArtifact"}},"required":["type","tenantDomain","auth"]},"AuthPowerBI":{"title":"Power BI Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthPowerBIResourceOwnerPassword"},{"$ref":"#/components/schemas/AuthPowerBIServicePrincipal"}],"discriminator":{"propertyName":"type","mapping":{"AuthPowerBIResourceOwnerPassword":"#/components/schemas/AuthPowerBIResourceOwnerPassword","AuthPowerBIServicePrincipal":"#/components/schemas/AuthPowerBIServicePrincipal"}}},"AuthPowerBIResourceOwnerPassword":{"title":"Power BI Resource Owner Password Credentials Authentication","type":"object","description":"Resource Owner Password Credentials authentication for Power BI","properties":{"type":{"type":"string","pattern":"^AuthPowerBIResourceOwnerPassword$"},"applicationId":{"description":"Application ID","$ref":"#/components/schemas/ParameterString"},"username":{"description":"Username","$ref":"#/components/schemas/ParameterString"},"passwordSecretKey":{"description":"Password/Secret key","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","applicationId","username","passwordSecretKey"]},"AuthPowerBIServicePrincipal":{"title":"Power BI Service Principal Authentication","type":"object","description":"Service Principal authentication for Power BI","properties":{"type":{"type":"string","pattern":"^AuthPowerBIServicePrincipal$"},"applicationId":{"description":"Application ID","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret for the service principal","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","applicationId","clientSecret"]},"ConnectionS3Compatible":{"type":"object","title":"S3-Compatible Connection","description":"Connection to a self-hosted or third-party S3-compatible storage service (e.g. MinIO, Ceph, NetApp StorageGRID).\n","properties":{"type":{"type":"string","pattern":"^ConnectionS3Compatible$","description":"Discriminator for S3-Compatible connection"},"endpoint":{"description":"URL of the S3-compatible storage endpoint, e.g. https://minio.example.com","$ref":"#/components/schemas/ParameterString"},"region":{"description":"Region identifier for the S3-compatible storage service.","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthS3Compatible"}},"required":["type","endpoint","auth"]},"AuthS3Compatible":{"title":"S3-Compatible Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthS3CompatibleAccessKey"}],"discriminator":{"propertyName":"type","mapping":{"AuthS3CompatibleAccessKey":"#/components/schemas/AuthS3CompatibleAccessKey"}}},"AuthS3CompatibleAccessKey":{"title":"S3-Compatible Access Key Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthS3CompatibleAccessKey$"},"accessKeyId":{"description":"Access key ID for the S3-compatible storage service.","$ref":"#/components/schemas/ParameterString"},"secretAccessKey":{"description":"Secret access key for the S3-compatible storage service.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","accessKeyId","secretAccessKey"]},"ConnectionSapAICore":{"type":"object","title":"SAP AI Core Connection","description":"SAP AI Core connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionSapAICore$","description":"Discriminator for SAP AI Core connection"},"url":{"description":"SAP AI Core URL","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthSapAICore"}},"required":["type","url","auth"]},"AuthSapAICore":{"title":"SAP AI Core Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthClientCredentialsWithTokenUrl"}],"discriminator":{"propertyName":"type","mapping":{"AuthClientCredentialsWithTokenUrl":"#/components/schemas/AuthClientCredentialsWithTokenUrl"}}},"ConnectionSapDatasphereCatalog":{"type":"object","title":"SAP Datasphere Catalog Connection","description":"SAP Datasphere Catalog connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionSapDatasphereCatalog$","description":"Discriminator for SAP Datasphere Catalog connection"},"url":{"description":"SAP Datasphere Catalog URL","$ref":"#/components/schemas/ParameterString"},"datasphereCatalogAuth":{"description":"OAuth client credentials for ingesting the SAP Datasphere Catalog.","$ref":"#/components/schemas/AuthSapDatasphereCatalog"},"dataProductsAuth":{"description":"Optional OAuth client credentials for ingesting SAP Data Products. When omitted, SAP Data Products are not ingested.","$ref":"#/components/schemas/AuthClientCredentials"}},"required":["type","url","datasphereCatalogAuth"]},"AuthSapDatasphereCatalog":{"title":"SAP Datasphere Catalog Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthClientCredentialsWithTokenUrl"}],"discriminator":{"propertyName":"type","mapping":{"AuthClientCredentialsWithTokenUrl":"#/components/schemas/AuthClientCredentialsWithTokenUrl"}}},"ConnectionSigma":{"type":"object","title":"Sigma Connection","description":"Sigma connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionSigma$","description":"Discriminator for Sigma connection"},"url":{"description":"Sigma instance base URL, e.g. https://aws-api.sigmacomputing.com","$ref":"#/components/schemas/ParameterString"},"tenantUrl":{"description":"Tenant-specific URL, e.g. https://app.sigmacomputing.com/your-tenant","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthSigma"}},"required":["type","url","tenantUrl","auth"]},"AuthSigma":{"title":"Sigma Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthClientCredentials"}],"discriminator":{"propertyName":"type","mapping":{"AuthClientCredentials":"#/components/schemas/AuthClientCredentials"}}},"ConnectionSnowflake":{"type":"object","title":"Snowflake Connection","description":"Snowflake connection.","properties":{"type":{"type":"string","pattern":"^ConnectionSnowflake$","description":"Discriminator for Snowflake connection."},"account":{"description":"The Account Identifier for the Snowflake account. This often includes cloud region information (e.g., xy123456.eu-central-1).","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthSnowflake"},"role":{"description":"The role to use in the Snowflake session.","$ref":"#/components/schemas/ParameterString"},"warehouse":{"description":"The name of the Snowflake warehouse. Defaults to the user's default warehouse if not specified.","$ref":"#/components/schemas/ParameterString"}},"required":["type","account","auth"]},"AuthSnowflake":{"title":"Snowflake Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthSnowflakeKeyPair"},{"$ref":"#/components/schemas/AuthSnowflakePat"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthSnowflakeKeyPair":"#/components/schemas/AuthSnowflakeKeyPair","AuthSnowflakePat":"#/components/schemas/AuthSnowflakePat"}}},"AuthSnowflakeKeyPair":{"title":"Snowflake Key Pair Authentication","type":"object","description":"Key pair authentication for Snowflake.","properties":{"type":{"type":"string","pattern":"^AuthSnowflakeKeyPair$"},"username":{"description":"The username to authenticate against the Snowflake account.","$ref":"#/components/schemas/ParameterString"},"privateKeyEdgeArtifact":{"description":"The private key artifact in P8 format for key pair authentication.","$ref":"#/components/schemas/ParameterSecretEdgeArtifact"},"privateKeyPwd":{"description":"The passphrase for the private key, if it is encrypted.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","username","privateKeyEdgeArtifact"]},"ParameterSecretEdgeArtifact":{"description":"References a sensitive artifact stored on the Edge site. The file content never leaves the Edge site cluster. Use for private keys and other sensitive artifacts.\n","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueSecretEdgeArtifactId"},{"$ref":"#/components/schemas/ValueVaultArtifact"}],"discriminator":{"propertyName":"type","mapping":{"ValueSecretEdgeArtifactId":"#/components/schemas/ValueSecretEdgeArtifactId","ValueVaultArtifact":"#/components/schemas/ValueVaultArtifact"}}},"AuthSnowflakePat":{"title":"Snowflake Programmatic Access Token Authentication","type":"object","description":"Programmatic Access Token (PAT) authentication for Snowflake.","properties":{"type":{"type":"string","pattern":"^AuthSnowflakePat$"},"programmaticAccessToken":{"description":"Programmatic Access Token generated in Snowflake.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","programmaticAccessToken"]},"ConnectionSsrs":{"type":"object","title":"Microsoft SSRS/PBRS Connection","description":"Microsoft SSRS/PBRS connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionSsrs$","description":"Discriminator for Microsoft SSRS/PBRS Connection"},"url":{"description":"Microsoft SSRS/PBRS URL","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthSsrs"}},"required":["type","url","auth"]},"AuthSsrs":{"title":"SSRS Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic"}}},"ConnectionTableau":{"type":"object","title":"Tableau Connection","description":"Tableau connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionTableau$","description":"Discriminator for Tableau Connection"},"url":{"description":"URL of the Tableau Server or Tableau Cloud site.","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthTableau"},"certFile":{"description":"Custom certificate","$ref":"#/components/schemas/ParameterEdgeArtifact"}},"required":["type","url","auth"]},"AuthTableau":{"title":"Tableau Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthTableauToken"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthTableauToken":"#/components/schemas/AuthTableauToken"}}},"AuthTableauToken":{"title":"Tableau Token Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthTableauToken$"},"tokenName":{"description":"Name of the service/account token (any unique meaningful name can be used)","$ref":"#/components/schemas/ParameterString"},"tokenSecret":{"description":"Value of the service/account token","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","tokenName","tokenSecret"]},"ConnectionThoughtSpot":{"type":"object","title":"ThoughtSpot Connection","description":"ThoughtSpot connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionThoughtSpot$","description":"Discriminator for ThoughtSpot connection"},"url":{"description":"ThoughtSpot instance base URL, e.g. https://customer.thoughtspot.cloud","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthThoughtSpot"}},"required":["type","url","auth"]},"AuthThoughtSpot":{"title":"ThoughtSpot Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic"}}}}}} ``` ## The ConnectionUpdate object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"ConnectionUpdate":{"type":"object","properties":{"name":{"type":"string","pattern":"^[a-zA-Z0-9_.-]+$","maxLength":255},"description":{"type":"string","maxLength":4000},"vaultId":{"type":"string","format":"uuid","description":"Associated vault id, if configured"},"properties":{"$ref":"#/components/schemas/ConnectionProperties"}},"required":["name","properties"],"description":"Request body to fully replace a data source connection. This is a full replacement, not a partial update - every field must be supplied on each call or it will be reset to its default. `name` is required, and changing it renames the connection. `edgeSiteId` is set at creation and cannot be changed; it is ignored if included in the request body.\n"},"ConnectionProperties":{"oneOf":[{"$ref":"#/components/schemas/ConnectionAws"},{"$ref":"#/components/schemas/ConnectionAzure"},{"$ref":"#/components/schemas/ConnectionDatabricks"},{"$ref":"#/components/schemas/ConnectionDbt"},{"$ref":"#/components/schemas/ConnectionGcp"},{"$ref":"#/components/schemas/ConnectionGit"},{"$ref":"#/components/schemas/ConnectionHttp"},{"$ref":"#/components/schemas/ConnectionIics"},{"$ref":"#/components/schemas/ConnectionJdbc"},{"$ref":"#/components/schemas/ConnectionLocalStorage"},{"$ref":"#/components/schemas/ConnectionLooker"},{"$ref":"#/components/schemas/ConnectionMatillion"},{"$ref":"#/components/schemas/ConnectionMicroStrategy"},{"$ref":"#/components/schemas/ConnectionMlflow"},{"$ref":"#/components/schemas/ConnectionPowerBI"},{"$ref":"#/components/schemas/ConnectionS3Compatible"},{"$ref":"#/components/schemas/ConnectionSapAICore"},{"$ref":"#/components/schemas/ConnectionSapDatasphereCatalog"},{"$ref":"#/components/schemas/ConnectionSigma"},{"$ref":"#/components/schemas/ConnectionSnowflake"},{"$ref":"#/components/schemas/ConnectionSsrs"},{"$ref":"#/components/schemas/ConnectionTableau"},{"$ref":"#/components/schemas/ConnectionThoughtSpot"}],"discriminator":{"propertyName":"type","mapping":{"ConnectionAws":"#/components/schemas/ConnectionAws","ConnectionAzure":"#/components/schemas/ConnectionAzure","ConnectionDatabricks":"#/components/schemas/ConnectionDatabricks","ConnectionDbt":"#/components/schemas/ConnectionDbt","ConnectionGcp":"#/components/schemas/ConnectionGcp","ConnectionGit":"#/components/schemas/ConnectionGit","ConnectionHttp":"#/components/schemas/ConnectionHttp","ConnectionIics":"#/components/schemas/ConnectionIics","ConnectionJdbc":"#/components/schemas/ConnectionJdbc","ConnectionLocalStorage":"#/components/schemas/ConnectionLocalStorage","ConnectionLooker":"#/components/schemas/ConnectionLooker","ConnectionMatillion":"#/components/schemas/ConnectionMatillion","ConnectionMicroStrategy":"#/components/schemas/ConnectionMicroStrategy","ConnectionMlflow":"#/components/schemas/ConnectionMlflow","ConnectionPowerBI":"#/components/schemas/ConnectionPowerBI","ConnectionS3Compatible":"#/components/schemas/ConnectionS3Compatible","ConnectionSapAICore":"#/components/schemas/ConnectionSapAICore","ConnectionSapDatasphereCatalog":"#/components/schemas/ConnectionSapDatasphereCatalog","ConnectionSigma":"#/components/schemas/ConnectionSigma","ConnectionSnowflake":"#/components/schemas/ConnectionSnowflake","ConnectionSsrs":"#/components/schemas/ConnectionSsrs","ConnectionTableau":"#/components/schemas/ConnectionTableau","ConnectionThoughtSpot":"#/components/schemas/ConnectionThoughtSpot"}}},"ConnectionAws":{"type":"object","title":"AWS Connection","description":"AWS connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionAws$","description":"Discriminator for AWS connection"},"auth":{"$ref":"#/components/schemas/AuthAws"},"parameters":{"$ref":"#/components/schemas/ParameterGenericMap"}},"required":["type","auth"]},"AuthAws":{"title":"AWS Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthAwsEc2"},{"$ref":"#/components/schemas/AuthAwsIam"}],"discriminator":{"propertyName":"type","mapping":{"AuthAwsEc2":"#/components/schemas/AuthAwsEc2","AuthAwsIam":"#/components/schemas/AuthAwsIam"}}},"AuthAwsEc2":{"title":"AWS EC2 Instance Profile Authentication","type":"object","description":"Authenticate via the IAM role attached to the EC2 instance running the Edge site. No credentials are configured on the connection.","properties":{"type":{"type":"string","pattern":"^AuthAwsEc2$"}},"required":["type"]},"AuthAwsIam":{"title":"AWS IAM Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthAwsIam$"},"awsAccessKeyId":{"description":"AWS Access Key ID","$ref":"#/components/schemas/ParameterString"},"awsSecretKey":{"description":"AWS Secret Access Key","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","awsAccessKeyId","awsSecretKey"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}},"ParameterGenericMap":{"type":"object","description":"Map of parameters for connections used to pass additional configuration.","additionalProperties":{"$ref":"#/components/schemas/ParameterGeneric"}},"ParameterGeneric":{"title":"Generic Parameter","description":"A parameter value for use in a data source connection parameter configuration.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueEdgeArtifactId"},{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueSecretEdgeArtifactId"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultArtifact"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueEdgeArtifactId":"#/components/schemas/ValueEdgeArtifactId","ValueRedacted":"#/components/schemas/ValueRedacted","ValueSecretEdgeArtifactId":"#/components/schemas/ValueSecretEdgeArtifactId","ValueString":"#/components/schemas/ValueString","ValueVaultArtifact":"#/components/schemas/ValueVaultArtifact","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueEdgeArtifactId":{"title":"Edge Artifact ID","description":"References a non-sensitive artifact stored on the Collibra instance and uploaded via `POST /artifacts`. Use for files such as SSL certificates and driver libraries.\n","type":"object","required":["type","edgeArtifactId"],"properties":{"type":{"type":"string","pattern":"^ValueEdgeArtifactId$"},"edgeArtifactId":{"type":"string","format":"uuid","description":"Reference id of the artifact uploaded via `POST /artifacts`."}}},"ValueSecretEdgeArtifactId":{"title":"Secret Edge Artifact ID","description":"References a secret artifact stored on the Edge site and uploaded via `POST /sites/{siteId}/secretArtifacts`. The file content never leaves the Edge site cluster. Use for private keys and other sensitive artifacts. Each secret artifact can only be referenced by a single connection and cannot be reused.\n","type":"object","required":["type","secretEdgeArtifactId"],"properties":{"type":{"type":"string","pattern":"^ValueSecretEdgeArtifactId$"},"secretEdgeArtifactId":{"type":"string","maxLength":512,"description":"The `id` value returned by `POST /sites/{siteId}/secretArtifacts`.\n"}}},"ValueVaultArtifact":{"title":"VaultArtifactReference","description":"Reference to a vault-stored secret that resolves to a file artifact. Use this instead of `EdgeArtifact` when the file should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultArtifact$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"ConnectionAzure":{"type":"object","title":"Azure Connection","description":"Azure connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionAzure$","description":"Discriminator for Azure connection"},"usGovernmentCloudHost":{"description":"Indicates whether Azure US Government Cloud is the host for Microsoft Entra.","type":"boolean","default":false},"auth":{"$ref":"#/components/schemas/AuthAzure"}},"required":["type","auth"]},"AuthAzure":{"title":"Azure Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthAzureServicePrincipal"}],"discriminator":{"propertyName":"type","mapping":{"AuthAzureServicePrincipal":"#/components/schemas/AuthAzureServicePrincipal"}}},"AuthAzureServicePrincipal":{"type":"object","title":"Azure Service Principal Authentication","properties":{"type":{"type":"string","pattern":"^AuthAzureServicePrincipal$"},"clientId":{"description":"The ID of the Service Principal used to connect to Azure","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"The Secret Key for the Service Principal","$ref":"#/components/schemas/ParameterSecretString"},"tenantId":{"description":"The Tenant ID of your Azure AD","$ref":"#/components/schemas/ParameterString"}},"required":["type","clientId","clientSecret","tenantId"]},"ConnectionDatabricks":{"type":"object","title":"Databricks Connection","description":"Databricks connection.","properties":{"type":{"type":"string","pattern":"^ConnectionDatabricks$","description":"Discriminator for Databricks connection."},"workspaceUrl":{"description":"Workspace URL on Databricks.","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthDatabricks"}},"required":["type","workspaceUrl","auth"]},"AuthDatabricks":{"title":"Databricks Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthClientCredentials"},{"$ref":"#/components/schemas/AuthDatabricksEntraId"},{"$ref":"#/components/schemas/AuthToken"}],"discriminator":{"propertyName":"type","mapping":{"AuthClientCredentials":"#/components/schemas/AuthClientCredentials","AuthDatabricksEntraId":"#/components/schemas/AuthDatabricksEntraId","AuthToken":"#/components/schemas/AuthToken"}}},"AuthClientCredentials":{"title":"Client Credentials Authentication","type":"object","description":"Generic client credentials (client ID + secret) authentication, reusable across connection types.","properties":{"type":{"type":"string","pattern":"^AuthClientCredentials$"},"clientId":{"description":"Client ID","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","clientId","clientSecret"]},"AuthDatabricksEntraId":{"title":"Databricks Microsoft Entra ID Authentication","type":"object","description":"Microsoft Entra ID (Azure AD) authentication for Databricks.","properties":{"type":{"type":"string","pattern":"^AuthDatabricksEntraId$"},"clientId":{"description":"Client ID of the Microsoft Entra ID service principal.","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret of the Microsoft Entra ID service principal.","$ref":"#/components/schemas/ParameterSecretString"},"tenantId":{"description":"Tenant ID for Microsoft Entra ID authentication.","$ref":"#/components/schemas/ParameterString"}},"required":["type","clientId","clientSecret","tenantId"]},"AuthToken":{"title":"Token Authentication","type":"object","description":"Generic single-token authentication, reusable across connection types.","properties":{"type":{"type":"string","pattern":"^AuthToken$"},"token":{"description":"Token value for authentication.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","token"]},"ConnectionDbt":{"type":"object","title":"dbt Connection","description":"dbt connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionDbt$","description":"Discriminator for dbt Connection"},"adminUrl":{"description":"Optional dbt admin API URL. Defaults to https://cloud.getdbt.com/api/v2","$ref":"#/components/schemas/ParameterString"},"metadataUrl":{"description":"Optional dbt metadata URL. Defaults to https://metadata.cloud.getdbt.com/graphql","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthDbt"}},"required":["type","auth"]},"AuthDbt":{"title":"dbt Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthDbtToken"}],"discriminator":{"propertyName":"type","mapping":{"AuthDbtToken":"#/components/schemas/AuthDbtToken"}}},"AuthDbtToken":{"title":"dbt Token Authentication","type":"object","description":"A dbt Cloud service token with the required permissions, used for authentication.","properties":{"type":{"type":"string","pattern":"^AuthDbtToken$"},"tokenName":{"description":"Name of the service/account token (any unique meaningful name can be used)","$ref":"#/components/schemas/ParameterString"},"tokenValue":{"description":"Value of the service/account token (the copied value from dbt Cloud)","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","tokenName","tokenValue"]},"ConnectionGcp":{"type":"object","title":"GCP Connection","description":"GCP connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionGcp$","description":"Discriminator for GCP Connection"},"auth":{"$ref":"#/components/schemas/AuthGcp"},"parameters":{"$ref":"#/components/schemas/ParameterGenericMap"}},"required":["type","auth"]},"AuthGcp":{"title":"GCP Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthGcpServiceAccount"},{"$ref":"#/components/schemas/AuthGcpWif"},{"$ref":"#/components/schemas/AuthGcpWifGke"}],"discriminator":{"propertyName":"type","mapping":{"AuthGcpServiceAccount":"#/components/schemas/AuthGcpServiceAccount","AuthGcpWif":"#/components/schemas/AuthGcpWif","AuthGcpWifGke":"#/components/schemas/AuthGcpWifGke"}}},"AuthGcpServiceAccount":{"title":"GCP Service Account Authentication","type":"object","description":"GCP Service Account authentication (full JSON key)","properties":{"type":{"type":"string","pattern":"^AuthGcpServiceAccount$"},"credentialsJson":{"description":"Full JSON key for the service account","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","credentialsJson"]},"AuthGcpWif":{"title":"GCP Workload Identity Federation (WIF) Authentication","type":"object","description":"Workload Identity Federation (WIF) - token URL or token","properties":{"type":{"type":"string","pattern":"^AuthGcpWif$"},"tokenOrTokenUrl":{"description":"Token URL or token for WIF","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","tokenOrTokenUrl"]},"AuthGcpWifGke":{"title":"GCP Workload Identity Federation (WIF) using GKE Authentication","type":"object","description":"Workload Identity Federation (WIF) using GKE - credentials from GKE, leave blank","properties":{"type":{"type":"string","pattern":"^AuthGcpWifGke$"}},"required":["type"]},"ConnectionGit":{"type":"object","title":"Git Connection","description":"Connection to a Git repository\n","properties":{"type":{"type":"string","pattern":"^ConnectionGit$","description":"Discriminator for Git connection"},"repositoryUrl":{"description":"HTTPS URL of the Git repository root, e.g. https://github.com/org/repo.git","$ref":"#/components/schemas/ParameterString"},"subfolder":{"description":"Path to a specific subfolder within the repository, e.g. src or projects/analytics.","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthGit"}},"required":["type","repositoryUrl","auth"]},"AuthGit":{"title":"Git Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthGitAccessToken"}],"discriminator":{"propertyName":"type","mapping":{"AuthGitAccessToken":"#/components/schemas/AuthGitAccessToken"}}},"AuthGitAccessToken":{"title":"Git Access Token Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthGitAccessToken$"},"username":{"description":"Username for authentication. Required for Bitbucket repositories.","$ref":"#/components/schemas/ParameterString"},"accessToken":{"description":"Personal access token for authenticating with the Git repository.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","accessToken"]},"ConnectionHttp":{"type":"object","title":"HTTP Connection","description":"Allows workflows to communicate with other HTTP based systems.\n","properties":{"type":{"type":"string","pattern":"^ConnectionHttp$","description":"Discriminator for HTTP connection"},"host":{"description":"The protocol and domain name of the server to connect to, for example, https://api.example.com","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthHttp"},"testConnectionPath":{"description":"The path for testing this connection with a GET call, for example, /v1/health.","$ref":"#/components/schemas/ParameterString"}},"required":["type","host"]},"AuthHttp":{"title":"HTTP Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthNone"},{"$ref":"#/components/schemas/AuthOAuth2"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthNone":"#/components/schemas/AuthNone","AuthOAuth2":"#/components/schemas/AuthOAuth2"}}},"AuthBasic":{"title":"Basic Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthBasic$"},"username":{"description":"Username","$ref":"#/components/schemas/ParameterString"},"password":{"description":"Password","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","username","password"]},"AuthNone":{"title":"No Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthNone$"}},"required":["type"]},"AuthOAuth2":{"title":"OAuth 2.0 Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthOAuth2$"},"clientId":{"description":"Client id","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret","$ref":"#/components/schemas/ParameterSecretString"},"accessTokenUri":{"description":"Access token URI","$ref":"#/components/schemas/ParameterString"},"scopes":{"description":"Scopes","$ref":"#/components/schemas/ParameterString"}},"required":["type","clientId","clientSecret","accessTokenUri"]},"ConnectionIics":{"type":"object","title":"Informatica Intelligent Cloud Services (IICS) Connection","description":"IICS connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionIics$","description":"Discriminator for Informatica Intelligent Cloud Services (IICS) Connection"},"url":{"description":"IICS Url","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthIics"}},"required":["type","url","auth"]},"AuthIics":{"title":"IICS Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic"}}},"ConnectionJdbc":{"title":"JDBC Connection","type":"object","required":["type","driver","connectionString"],"properties":{"type":{"type":"string","pattern":"^ConnectionJdbc$","description":"Discriminator for JDBC connection types."},"driver":{"$ref":"#/components/schemas/JdbcDriver"},"connectionString":{"$ref":"#/components/schemas/ParameterString","description":"JDBC connection string, e.g. \"jdbc:mysql://localhost:3306/mydb\""},"auth":{"description":"Authentication configuration. When omitted, defaults to AuthNone.","$ref":"#/components/schemas/AuthJdbc"},"parameters":{"description":"Additional JDBC connection properties, such as SSL settings, timeouts, etc. These are passed as key-value pairs in the connection string.","allOf":[{"$ref":"#/components/schemas/ParameterGenericMap"}]}}},"JdbcDriver":{"type":"object","description":"JDBC driver configuration (`JdbcDriverDirect`). Specify the driver jar, an optional classpath, and the fully qualified driver class name.","oneOf":[{"$ref":"#/components/schemas/JdbcDriverDirect"}],"discriminator":{"propertyName":"type","mapping":{"JdbcDriverDirect":"#/components/schemas/JdbcDriverDirect"}}},"JdbcDriverDirect":{"title":"Direct JDBC Driver","type":"object","properties":{"type":{"type":"string","pattern":"^JdbcDriverDirect$"},"className":{"type":"string","description":"Fully qualified class name of the JDBC driver (e.g. \"org.postgresql.Driver\", \"com.mysql.cj.jdbc.Driver\", etc.).","maxLength":100,"pattern":"^[a-zA-Z0-9._$]+$"},"jar":{"type":"string","format":"uuid","description":"Reference id of the driver jar uploaded via `POST /drivers/jars`."},"additionalClasspathFiles":{"type":"array","maxItems":10,"items":{"type":"string","format":"uuid","description":"Reference id of a driver jar or native library uploaded via `POST /drivers/jars` or `POST /drivers/nativeLibs`."}}},"required":["className","type","jar"],"description":"This schema contains the allowed configuration files that can be uploaded to set up a JDBC connection type."},"AuthJdbc":{"title":"JDBC Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthNone"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthNone":"#/components/schemas/AuthNone"}}},"ConnectionLocalStorage":{"type":"object","title":"Shared Storage Connection","description":"Read-only access to a folder located on the Edge site. Used for technical lineage ingestion via OpenLineage (AWS Glue, Apache Airflow, OpenLineage).\n","properties":{"type":{"type":"string","pattern":"^ConnectionLocalStorage$","description":"Discriminator for shared storage connection"},"folder":{"description":"--target as specified in ./edgecli object folder-upload","type":"string","pattern":"^[\\w-]+$"}},"required":["type","folder"]},"ConnectionLooker":{"type":"object","title":"Looker Connection","description":"Looker connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionLooker$","description":"Discriminator for Looker Connection"},"url":{"description":"Looker URL","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthLooker"}},"required":["type","url","auth"]},"AuthLooker":{"title":"Looker Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthClientCredentials"}],"discriminator":{"propertyName":"type","mapping":{"AuthClientCredentials":"#/components/schemas/AuthClientCredentials"}}},"ConnectionMatillion":{"type":"object","title":"Matillion Connection","description":"Matillion connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionMatillion$","description":"Discriminator for Matillion Connection"},"url":{"description":"Matillion Url","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthMatillion"},"certFile":{"description":"Custom certificate","$ref":"#/components/schemas/ParameterEdgeArtifact"}},"required":["type","url","auth"]},"AuthMatillion":{"title":"Matillion Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthToken"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthToken":"#/components/schemas/AuthToken"}}},"ParameterEdgeArtifact":{"description":"References a non-sensitive artifact stored on the customer's Collibra Platform instance. Use for SSL certificates, driver libraries, and other files that do not need to stay within the customer's Edge site.\n","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueEdgeArtifactId"},{"$ref":"#/components/schemas/ValueVaultArtifact"}],"discriminator":{"propertyName":"type","mapping":{"ValueEdgeArtifactId":"#/components/schemas/ValueEdgeArtifactId","ValueVaultArtifact":"#/components/schemas/ValueVaultArtifact"}}},"ConnectionMicroStrategy":{"type":"object","title":"MicroStrategy Connection","description":"MicroStrategy connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionMicroStrategy$","description":"Discriminator for MicroStrategy Connection"},"url":{"description":"MicroStrategy URL","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthMicroStrategy"}},"required":["type","url","auth"]},"AuthMicroStrategy":{"title":"MicroStrategy Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthToken"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthToken":"#/components/schemas/AuthToken"}}},"ConnectionMlflow":{"type":"object","title":"MLflow Connection","description":"MLflow connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionMlflow$","description":"Discriminator for MLflow connection"},"url":{"description":"MLflow URL","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthMlflow"}},"required":["type","url","auth"]},"AuthMlflow":{"title":"MLflow Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthClientCredentialsWithTokenUrl"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthClientCredentialsWithTokenUrl":"#/components/schemas/AuthClientCredentialsWithTokenUrl"}}},"AuthClientCredentialsWithTokenUrl":{"title":"Client Credentials with Token URL Authentication","type":"object","description":"OAuth client credentials with token URL (client ID, secret, and token endpoint)","properties":{"type":{"type":"string","pattern":"^AuthClientCredentialsWithTokenUrl$"},"clientId":{"description":"Client ID","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret","$ref":"#/components/schemas/ParameterSecretString"},"tokenUrl":{"description":"The token URL of the OAuth client","$ref":"#/components/schemas/ParameterString"}},"required":["type","clientId","clientSecret","tokenUrl"]},"ConnectionPowerBI":{"type":"object","title":"Power BI Connection","description":"Power BI (SaaS) connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionPowerBI$","description":"Discriminator for Power BI Connection"},"tenantDomain":{"description":"Tenant Domain","$ref":"#/components/schemas/ParameterString"},"auth":{"description":"Authentication configuration for Power BI. Supports ServicePrincipal and ResourceOwnerPassword flows.\n","$ref":"#/components/schemas/AuthPowerBI"},"certFile":{"description":"Optional custom SSL/TLS certificate, in PEM format, used to establish a trusted HTTPS connection to the Power BI service. Provide this when the connection is routed through a proxy or gateway that presents a certificate signed by a custom or private Certificate Authority that is not trusted by default. The certificate is referenced as a non-sensitive artifact stored on the customer's Collibra Platform instance. When omitted, the system's default trusted CAs are used.\n","$ref":"#/components/schemas/ParameterEdgeArtifact"}},"required":["type","tenantDomain","auth"]},"AuthPowerBI":{"title":"Power BI Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthPowerBIResourceOwnerPassword"},{"$ref":"#/components/schemas/AuthPowerBIServicePrincipal"}],"discriminator":{"propertyName":"type","mapping":{"AuthPowerBIResourceOwnerPassword":"#/components/schemas/AuthPowerBIResourceOwnerPassword","AuthPowerBIServicePrincipal":"#/components/schemas/AuthPowerBIServicePrincipal"}}},"AuthPowerBIResourceOwnerPassword":{"title":"Power BI Resource Owner Password Credentials Authentication","type":"object","description":"Resource Owner Password Credentials authentication for Power BI","properties":{"type":{"type":"string","pattern":"^AuthPowerBIResourceOwnerPassword$"},"applicationId":{"description":"Application ID","$ref":"#/components/schemas/ParameterString"},"username":{"description":"Username","$ref":"#/components/schemas/ParameterString"},"passwordSecretKey":{"description":"Password/Secret key","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","applicationId","username","passwordSecretKey"]},"AuthPowerBIServicePrincipal":{"title":"Power BI Service Principal Authentication","type":"object","description":"Service Principal authentication for Power BI","properties":{"type":{"type":"string","pattern":"^AuthPowerBIServicePrincipal$"},"applicationId":{"description":"Application ID","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret for the service principal","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","applicationId","clientSecret"]},"ConnectionS3Compatible":{"type":"object","title":"S3-Compatible Connection","description":"Connection to a self-hosted or third-party S3-compatible storage service (e.g. MinIO, Ceph, NetApp StorageGRID).\n","properties":{"type":{"type":"string","pattern":"^ConnectionS3Compatible$","description":"Discriminator for S3-Compatible connection"},"endpoint":{"description":"URL of the S3-compatible storage endpoint, e.g. https://minio.example.com","$ref":"#/components/schemas/ParameterString"},"region":{"description":"Region identifier for the S3-compatible storage service.","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthS3Compatible"}},"required":["type","endpoint","auth"]},"AuthS3Compatible":{"title":"S3-Compatible Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthS3CompatibleAccessKey"}],"discriminator":{"propertyName":"type","mapping":{"AuthS3CompatibleAccessKey":"#/components/schemas/AuthS3CompatibleAccessKey"}}},"AuthS3CompatibleAccessKey":{"title":"S3-Compatible Access Key Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthS3CompatibleAccessKey$"},"accessKeyId":{"description":"Access key ID for the S3-compatible storage service.","$ref":"#/components/schemas/ParameterString"},"secretAccessKey":{"description":"Secret access key for the S3-compatible storage service.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","accessKeyId","secretAccessKey"]},"ConnectionSapAICore":{"type":"object","title":"SAP AI Core Connection","description":"SAP AI Core connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionSapAICore$","description":"Discriminator for SAP AI Core connection"},"url":{"description":"SAP AI Core URL","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthSapAICore"}},"required":["type","url","auth"]},"AuthSapAICore":{"title":"SAP AI Core Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthClientCredentialsWithTokenUrl"}],"discriminator":{"propertyName":"type","mapping":{"AuthClientCredentialsWithTokenUrl":"#/components/schemas/AuthClientCredentialsWithTokenUrl"}}},"ConnectionSapDatasphereCatalog":{"type":"object","title":"SAP Datasphere Catalog Connection","description":"SAP Datasphere Catalog connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionSapDatasphereCatalog$","description":"Discriminator for SAP Datasphere Catalog connection"},"url":{"description":"SAP Datasphere Catalog URL","$ref":"#/components/schemas/ParameterString"},"datasphereCatalogAuth":{"description":"OAuth client credentials for ingesting the SAP Datasphere Catalog.","$ref":"#/components/schemas/AuthSapDatasphereCatalog"},"dataProductsAuth":{"description":"Optional OAuth client credentials for ingesting SAP Data Products. When omitted, SAP Data Products are not ingested.","$ref":"#/components/schemas/AuthClientCredentials"}},"required":["type","url","datasphereCatalogAuth"]},"AuthSapDatasphereCatalog":{"title":"SAP Datasphere Catalog Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthClientCredentialsWithTokenUrl"}],"discriminator":{"propertyName":"type","mapping":{"AuthClientCredentialsWithTokenUrl":"#/components/schemas/AuthClientCredentialsWithTokenUrl"}}},"ConnectionSigma":{"type":"object","title":"Sigma Connection","description":"Sigma connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionSigma$","description":"Discriminator for Sigma connection"},"url":{"description":"Sigma instance base URL, e.g. https://aws-api.sigmacomputing.com","$ref":"#/components/schemas/ParameterString"},"tenantUrl":{"description":"Tenant-specific URL, e.g. https://app.sigmacomputing.com/your-tenant","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthSigma"}},"required":["type","url","tenantUrl","auth"]},"AuthSigma":{"title":"Sigma Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthClientCredentials"}],"discriminator":{"propertyName":"type","mapping":{"AuthClientCredentials":"#/components/schemas/AuthClientCredentials"}}},"ConnectionSnowflake":{"type":"object","title":"Snowflake Connection","description":"Snowflake connection.","properties":{"type":{"type":"string","pattern":"^ConnectionSnowflake$","description":"Discriminator for Snowflake connection."},"account":{"description":"The Account Identifier for the Snowflake account. This often includes cloud region information (e.g., xy123456.eu-central-1).","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthSnowflake"},"role":{"description":"The role to use in the Snowflake session.","$ref":"#/components/schemas/ParameterString"},"warehouse":{"description":"The name of the Snowflake warehouse. Defaults to the user's default warehouse if not specified.","$ref":"#/components/schemas/ParameterString"}},"required":["type","account","auth"]},"AuthSnowflake":{"title":"Snowflake Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthSnowflakeKeyPair"},{"$ref":"#/components/schemas/AuthSnowflakePat"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthSnowflakeKeyPair":"#/components/schemas/AuthSnowflakeKeyPair","AuthSnowflakePat":"#/components/schemas/AuthSnowflakePat"}}},"AuthSnowflakeKeyPair":{"title":"Snowflake Key Pair Authentication","type":"object","description":"Key pair authentication for Snowflake.","properties":{"type":{"type":"string","pattern":"^AuthSnowflakeKeyPair$"},"username":{"description":"The username to authenticate against the Snowflake account.","$ref":"#/components/schemas/ParameterString"},"privateKeyEdgeArtifact":{"description":"The private key artifact in P8 format for key pair authentication.","$ref":"#/components/schemas/ParameterSecretEdgeArtifact"},"privateKeyPwd":{"description":"The passphrase for the private key, if it is encrypted.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","username","privateKeyEdgeArtifact"]},"ParameterSecretEdgeArtifact":{"description":"References a sensitive artifact stored on the Edge site. The file content never leaves the Edge site cluster. Use for private keys and other sensitive artifacts.\n","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueSecretEdgeArtifactId"},{"$ref":"#/components/schemas/ValueVaultArtifact"}],"discriminator":{"propertyName":"type","mapping":{"ValueSecretEdgeArtifactId":"#/components/schemas/ValueSecretEdgeArtifactId","ValueVaultArtifact":"#/components/schemas/ValueVaultArtifact"}}},"AuthSnowflakePat":{"title":"Snowflake Programmatic Access Token Authentication","type":"object","description":"Programmatic Access Token (PAT) authentication for Snowflake.","properties":{"type":{"type":"string","pattern":"^AuthSnowflakePat$"},"programmaticAccessToken":{"description":"Programmatic Access Token generated in Snowflake.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","programmaticAccessToken"]},"ConnectionSsrs":{"type":"object","title":"Microsoft SSRS/PBRS Connection","description":"Microsoft SSRS/PBRS connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionSsrs$","description":"Discriminator for Microsoft SSRS/PBRS Connection"},"url":{"description":"Microsoft SSRS/PBRS URL","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthSsrs"}},"required":["type","url","auth"]},"AuthSsrs":{"title":"SSRS Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic"}}},"ConnectionTableau":{"type":"object","title":"Tableau Connection","description":"Tableau connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionTableau$","description":"Discriminator for Tableau Connection"},"url":{"description":"URL of the Tableau Server or Tableau Cloud site.","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthTableau"},"certFile":{"description":"Custom certificate","$ref":"#/components/schemas/ParameterEdgeArtifact"}},"required":["type","url","auth"]},"AuthTableau":{"title":"Tableau Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthTableauToken"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthTableauToken":"#/components/schemas/AuthTableauToken"}}},"AuthTableauToken":{"title":"Tableau Token Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthTableauToken$"},"tokenName":{"description":"Name of the service/account token (any unique meaningful name can be used)","$ref":"#/components/schemas/ParameterString"},"tokenSecret":{"description":"Value of the service/account token","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","tokenName","tokenSecret"]},"ConnectionThoughtSpot":{"type":"object","title":"ThoughtSpot Connection","description":"ThoughtSpot connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionThoughtSpot$","description":"Discriminator for ThoughtSpot connection"},"url":{"description":"ThoughtSpot instance base URL, e.g. https://customer.thoughtspot.cloud","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthThoughtSpot"}},"required":["type","url","auth"]},"AuthThoughtSpot":{"title":"ThoughtSpot Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic"}}}}}} ``` ## The ConnectionResponse object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"ConnectionResponse":{"type":"object","required":["id","name","edgeSiteId","properties","createdOn","lastModifiedOn","testConnectionSupported"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string"},"edgeSiteId":{"type":"string","format":"uuid"},"vaultId":{"type":"string","format":"uuid","description":"Associated vault id, if configured"},"createdOn":{"type":"string","format":"date-time"},"lastModifiedOn":{"type":"string","format":"date-time"},"testConnectionSupported":{"type":"boolean","readOnly":true,"description":"Indicates whether this connection type supports the test connection operation. Only connections with `testConnectionSupported: true` can be used with `POST /sites/{siteId}/connections/{connectionId}/test`.\n"},"properties":{"$ref":"#/components/schemas/ConnectionProperties"}},"description":"Response body for data source connection management endpoints."},"ConnectionProperties":{"oneOf":[{"$ref":"#/components/schemas/ConnectionAws"},{"$ref":"#/components/schemas/ConnectionAzure"},{"$ref":"#/components/schemas/ConnectionDatabricks"},{"$ref":"#/components/schemas/ConnectionDbt"},{"$ref":"#/components/schemas/ConnectionGcp"},{"$ref":"#/components/schemas/ConnectionGit"},{"$ref":"#/components/schemas/ConnectionHttp"},{"$ref":"#/components/schemas/ConnectionIics"},{"$ref":"#/components/schemas/ConnectionJdbc"},{"$ref":"#/components/schemas/ConnectionLocalStorage"},{"$ref":"#/components/schemas/ConnectionLooker"},{"$ref":"#/components/schemas/ConnectionMatillion"},{"$ref":"#/components/schemas/ConnectionMicroStrategy"},{"$ref":"#/components/schemas/ConnectionMlflow"},{"$ref":"#/components/schemas/ConnectionPowerBI"},{"$ref":"#/components/schemas/ConnectionS3Compatible"},{"$ref":"#/components/schemas/ConnectionSapAICore"},{"$ref":"#/components/schemas/ConnectionSapDatasphereCatalog"},{"$ref":"#/components/schemas/ConnectionSigma"},{"$ref":"#/components/schemas/ConnectionSnowflake"},{"$ref":"#/components/schemas/ConnectionSsrs"},{"$ref":"#/components/schemas/ConnectionTableau"},{"$ref":"#/components/schemas/ConnectionThoughtSpot"}],"discriminator":{"propertyName":"type","mapping":{"ConnectionAws":"#/components/schemas/ConnectionAws","ConnectionAzure":"#/components/schemas/ConnectionAzure","ConnectionDatabricks":"#/components/schemas/ConnectionDatabricks","ConnectionDbt":"#/components/schemas/ConnectionDbt","ConnectionGcp":"#/components/schemas/ConnectionGcp","ConnectionGit":"#/components/schemas/ConnectionGit","ConnectionHttp":"#/components/schemas/ConnectionHttp","ConnectionIics":"#/components/schemas/ConnectionIics","ConnectionJdbc":"#/components/schemas/ConnectionJdbc","ConnectionLocalStorage":"#/components/schemas/ConnectionLocalStorage","ConnectionLooker":"#/components/schemas/ConnectionLooker","ConnectionMatillion":"#/components/schemas/ConnectionMatillion","ConnectionMicroStrategy":"#/components/schemas/ConnectionMicroStrategy","ConnectionMlflow":"#/components/schemas/ConnectionMlflow","ConnectionPowerBI":"#/components/schemas/ConnectionPowerBI","ConnectionS3Compatible":"#/components/schemas/ConnectionS3Compatible","ConnectionSapAICore":"#/components/schemas/ConnectionSapAICore","ConnectionSapDatasphereCatalog":"#/components/schemas/ConnectionSapDatasphereCatalog","ConnectionSigma":"#/components/schemas/ConnectionSigma","ConnectionSnowflake":"#/components/schemas/ConnectionSnowflake","ConnectionSsrs":"#/components/schemas/ConnectionSsrs","ConnectionTableau":"#/components/schemas/ConnectionTableau","ConnectionThoughtSpot":"#/components/schemas/ConnectionThoughtSpot"}}},"ConnectionAws":{"type":"object","title":"AWS Connection","description":"AWS connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionAws$","description":"Discriminator for AWS connection"},"auth":{"$ref":"#/components/schemas/AuthAws"},"parameters":{"$ref":"#/components/schemas/ParameterGenericMap"}},"required":["type","auth"]},"AuthAws":{"title":"AWS Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthAwsEc2"},{"$ref":"#/components/schemas/AuthAwsIam"}],"discriminator":{"propertyName":"type","mapping":{"AuthAwsEc2":"#/components/schemas/AuthAwsEc2","AuthAwsIam":"#/components/schemas/AuthAwsIam"}}},"AuthAwsEc2":{"title":"AWS EC2 Instance Profile Authentication","type":"object","description":"Authenticate via the IAM role attached to the EC2 instance running the Edge site. No credentials are configured on the connection.","properties":{"type":{"type":"string","pattern":"^AuthAwsEc2$"}},"required":["type"]},"AuthAwsIam":{"title":"AWS IAM Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthAwsIam$"},"awsAccessKeyId":{"description":"AWS Access Key ID","$ref":"#/components/schemas/ParameterString"},"awsSecretKey":{"description":"AWS Secret Access Key","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","awsAccessKeyId","awsSecretKey"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}},"ParameterGenericMap":{"type":"object","description":"Map of parameters for connections used to pass additional configuration.","additionalProperties":{"$ref":"#/components/schemas/ParameterGeneric"}},"ParameterGeneric":{"title":"Generic Parameter","description":"A parameter value for use in a data source connection parameter configuration.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueEdgeArtifactId"},{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueSecretEdgeArtifactId"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultArtifact"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueEdgeArtifactId":"#/components/schemas/ValueEdgeArtifactId","ValueRedacted":"#/components/schemas/ValueRedacted","ValueSecretEdgeArtifactId":"#/components/schemas/ValueSecretEdgeArtifactId","ValueString":"#/components/schemas/ValueString","ValueVaultArtifact":"#/components/schemas/ValueVaultArtifact","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueEdgeArtifactId":{"title":"Edge Artifact ID","description":"References a non-sensitive artifact stored on the Collibra instance and uploaded via `POST /artifacts`. Use for files such as SSL certificates and driver libraries.\n","type":"object","required":["type","edgeArtifactId"],"properties":{"type":{"type":"string","pattern":"^ValueEdgeArtifactId$"},"edgeArtifactId":{"type":"string","format":"uuid","description":"Reference id of the artifact uploaded via `POST /artifacts`."}}},"ValueSecretEdgeArtifactId":{"title":"Secret Edge Artifact ID","description":"References a secret artifact stored on the Edge site and uploaded via `POST /sites/{siteId}/secretArtifacts`. The file content never leaves the Edge site cluster. Use for private keys and other sensitive artifacts. Each secret artifact can only be referenced by a single connection and cannot be reused.\n","type":"object","required":["type","secretEdgeArtifactId"],"properties":{"type":{"type":"string","pattern":"^ValueSecretEdgeArtifactId$"},"secretEdgeArtifactId":{"type":"string","maxLength":512,"description":"The `id` value returned by `POST /sites/{siteId}/secretArtifacts`.\n"}}},"ValueVaultArtifact":{"title":"VaultArtifactReference","description":"Reference to a vault-stored secret that resolves to a file artifact. Use this instead of `EdgeArtifact` when the file should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultArtifact$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"ConnectionAzure":{"type":"object","title":"Azure Connection","description":"Azure connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionAzure$","description":"Discriminator for Azure connection"},"usGovernmentCloudHost":{"description":"Indicates whether Azure US Government Cloud is the host for Microsoft Entra.","type":"boolean","default":false},"auth":{"$ref":"#/components/schemas/AuthAzure"}},"required":["type","auth"]},"AuthAzure":{"title":"Azure Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthAzureServicePrincipal"}],"discriminator":{"propertyName":"type","mapping":{"AuthAzureServicePrincipal":"#/components/schemas/AuthAzureServicePrincipal"}}},"AuthAzureServicePrincipal":{"type":"object","title":"Azure Service Principal Authentication","properties":{"type":{"type":"string","pattern":"^AuthAzureServicePrincipal$"},"clientId":{"description":"The ID of the Service Principal used to connect to Azure","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"The Secret Key for the Service Principal","$ref":"#/components/schemas/ParameterSecretString"},"tenantId":{"description":"The Tenant ID of your Azure AD","$ref":"#/components/schemas/ParameterString"}},"required":["type","clientId","clientSecret","tenantId"]},"ConnectionDatabricks":{"type":"object","title":"Databricks Connection","description":"Databricks connection.","properties":{"type":{"type":"string","pattern":"^ConnectionDatabricks$","description":"Discriminator for Databricks connection."},"workspaceUrl":{"description":"Workspace URL on Databricks.","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthDatabricks"}},"required":["type","workspaceUrl","auth"]},"AuthDatabricks":{"title":"Databricks Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthClientCredentials"},{"$ref":"#/components/schemas/AuthDatabricksEntraId"},{"$ref":"#/components/schemas/AuthToken"}],"discriminator":{"propertyName":"type","mapping":{"AuthClientCredentials":"#/components/schemas/AuthClientCredentials","AuthDatabricksEntraId":"#/components/schemas/AuthDatabricksEntraId","AuthToken":"#/components/schemas/AuthToken"}}},"AuthClientCredentials":{"title":"Client Credentials Authentication","type":"object","description":"Generic client credentials (client ID + secret) authentication, reusable across connection types.","properties":{"type":{"type":"string","pattern":"^AuthClientCredentials$"},"clientId":{"description":"Client ID","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","clientId","clientSecret"]},"AuthDatabricksEntraId":{"title":"Databricks Microsoft Entra ID Authentication","type":"object","description":"Microsoft Entra ID (Azure AD) authentication for Databricks.","properties":{"type":{"type":"string","pattern":"^AuthDatabricksEntraId$"},"clientId":{"description":"Client ID of the Microsoft Entra ID service principal.","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret of the Microsoft Entra ID service principal.","$ref":"#/components/schemas/ParameterSecretString"},"tenantId":{"description":"Tenant ID for Microsoft Entra ID authentication.","$ref":"#/components/schemas/ParameterString"}},"required":["type","clientId","clientSecret","tenantId"]},"AuthToken":{"title":"Token Authentication","type":"object","description":"Generic single-token authentication, reusable across connection types.","properties":{"type":{"type":"string","pattern":"^AuthToken$"},"token":{"description":"Token value for authentication.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","token"]},"ConnectionDbt":{"type":"object","title":"dbt Connection","description":"dbt connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionDbt$","description":"Discriminator for dbt Connection"},"adminUrl":{"description":"Optional dbt admin API URL. Defaults to https://cloud.getdbt.com/api/v2","$ref":"#/components/schemas/ParameterString"},"metadataUrl":{"description":"Optional dbt metadata URL. Defaults to https://metadata.cloud.getdbt.com/graphql","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthDbt"}},"required":["type","auth"]},"AuthDbt":{"title":"dbt Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthDbtToken"}],"discriminator":{"propertyName":"type","mapping":{"AuthDbtToken":"#/components/schemas/AuthDbtToken"}}},"AuthDbtToken":{"title":"dbt Token Authentication","type":"object","description":"A dbt Cloud service token with the required permissions, used for authentication.","properties":{"type":{"type":"string","pattern":"^AuthDbtToken$"},"tokenName":{"description":"Name of the service/account token (any unique meaningful name can be used)","$ref":"#/components/schemas/ParameterString"},"tokenValue":{"description":"Value of the service/account token (the copied value from dbt Cloud)","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","tokenName","tokenValue"]},"ConnectionGcp":{"type":"object","title":"GCP Connection","description":"GCP connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionGcp$","description":"Discriminator for GCP Connection"},"auth":{"$ref":"#/components/schemas/AuthGcp"},"parameters":{"$ref":"#/components/schemas/ParameterGenericMap"}},"required":["type","auth"]},"AuthGcp":{"title":"GCP Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthGcpServiceAccount"},{"$ref":"#/components/schemas/AuthGcpWif"},{"$ref":"#/components/schemas/AuthGcpWifGke"}],"discriminator":{"propertyName":"type","mapping":{"AuthGcpServiceAccount":"#/components/schemas/AuthGcpServiceAccount","AuthGcpWif":"#/components/schemas/AuthGcpWif","AuthGcpWifGke":"#/components/schemas/AuthGcpWifGke"}}},"AuthGcpServiceAccount":{"title":"GCP Service Account Authentication","type":"object","description":"GCP Service Account authentication (full JSON key)","properties":{"type":{"type":"string","pattern":"^AuthGcpServiceAccount$"},"credentialsJson":{"description":"Full JSON key for the service account","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","credentialsJson"]},"AuthGcpWif":{"title":"GCP Workload Identity Federation (WIF) Authentication","type":"object","description":"Workload Identity Federation (WIF) - token URL or token","properties":{"type":{"type":"string","pattern":"^AuthGcpWif$"},"tokenOrTokenUrl":{"description":"Token URL or token for WIF","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","tokenOrTokenUrl"]},"AuthGcpWifGke":{"title":"GCP Workload Identity Federation (WIF) using GKE Authentication","type":"object","description":"Workload Identity Federation (WIF) using GKE - credentials from GKE, leave blank","properties":{"type":{"type":"string","pattern":"^AuthGcpWifGke$"}},"required":["type"]},"ConnectionGit":{"type":"object","title":"Git Connection","description":"Connection to a Git repository\n","properties":{"type":{"type":"string","pattern":"^ConnectionGit$","description":"Discriminator for Git connection"},"repositoryUrl":{"description":"HTTPS URL of the Git repository root, e.g. https://github.com/org/repo.git","$ref":"#/components/schemas/ParameterString"},"subfolder":{"description":"Path to a specific subfolder within the repository, e.g. src or projects/analytics.","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthGit"}},"required":["type","repositoryUrl","auth"]},"AuthGit":{"title":"Git Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthGitAccessToken"}],"discriminator":{"propertyName":"type","mapping":{"AuthGitAccessToken":"#/components/schemas/AuthGitAccessToken"}}},"AuthGitAccessToken":{"title":"Git Access Token Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthGitAccessToken$"},"username":{"description":"Username for authentication. Required for Bitbucket repositories.","$ref":"#/components/schemas/ParameterString"},"accessToken":{"description":"Personal access token for authenticating with the Git repository.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","accessToken"]},"ConnectionHttp":{"type":"object","title":"HTTP Connection","description":"Allows workflows to communicate with other HTTP based systems.\n","properties":{"type":{"type":"string","pattern":"^ConnectionHttp$","description":"Discriminator for HTTP connection"},"host":{"description":"The protocol and domain name of the server to connect to, for example, https://api.example.com","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthHttp"},"testConnectionPath":{"description":"The path for testing this connection with a GET call, for example, /v1/health.","$ref":"#/components/schemas/ParameterString"}},"required":["type","host"]},"AuthHttp":{"title":"HTTP Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthNone"},{"$ref":"#/components/schemas/AuthOAuth2"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthNone":"#/components/schemas/AuthNone","AuthOAuth2":"#/components/schemas/AuthOAuth2"}}},"AuthBasic":{"title":"Basic Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthBasic$"},"username":{"description":"Username","$ref":"#/components/schemas/ParameterString"},"password":{"description":"Password","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","username","password"]},"AuthNone":{"title":"No Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthNone$"}},"required":["type"]},"AuthOAuth2":{"title":"OAuth 2.0 Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthOAuth2$"},"clientId":{"description":"Client id","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret","$ref":"#/components/schemas/ParameterSecretString"},"accessTokenUri":{"description":"Access token URI","$ref":"#/components/schemas/ParameterString"},"scopes":{"description":"Scopes","$ref":"#/components/schemas/ParameterString"}},"required":["type","clientId","clientSecret","accessTokenUri"]},"ConnectionIics":{"type":"object","title":"Informatica Intelligent Cloud Services (IICS) Connection","description":"IICS connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionIics$","description":"Discriminator for Informatica Intelligent Cloud Services (IICS) Connection"},"url":{"description":"IICS Url","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthIics"}},"required":["type","url","auth"]},"AuthIics":{"title":"IICS Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic"}}},"ConnectionJdbc":{"title":"JDBC Connection","type":"object","required":["type","driver","connectionString"],"properties":{"type":{"type":"string","pattern":"^ConnectionJdbc$","description":"Discriminator for JDBC connection types."},"driver":{"$ref":"#/components/schemas/JdbcDriver"},"connectionString":{"$ref":"#/components/schemas/ParameterString","description":"JDBC connection string, e.g. \"jdbc:mysql://localhost:3306/mydb\""},"auth":{"description":"Authentication configuration. When omitted, defaults to AuthNone.","$ref":"#/components/schemas/AuthJdbc"},"parameters":{"description":"Additional JDBC connection properties, such as SSL settings, timeouts, etc. These are passed as key-value pairs in the connection string.","allOf":[{"$ref":"#/components/schemas/ParameterGenericMap"}]}}},"JdbcDriver":{"type":"object","description":"JDBC driver configuration (`JdbcDriverDirect`). Specify the driver jar, an optional classpath, and the fully qualified driver class name.","oneOf":[{"$ref":"#/components/schemas/JdbcDriverDirect"}],"discriminator":{"propertyName":"type","mapping":{"JdbcDriverDirect":"#/components/schemas/JdbcDriverDirect"}}},"JdbcDriverDirect":{"title":"Direct JDBC Driver","type":"object","properties":{"type":{"type":"string","pattern":"^JdbcDriverDirect$"},"className":{"type":"string","description":"Fully qualified class name of the JDBC driver (e.g. \"org.postgresql.Driver\", \"com.mysql.cj.jdbc.Driver\", etc.).","maxLength":100,"pattern":"^[a-zA-Z0-9._$]+$"},"jar":{"type":"string","format":"uuid","description":"Reference id of the driver jar uploaded via `POST /drivers/jars`."},"additionalClasspathFiles":{"type":"array","maxItems":10,"items":{"type":"string","format":"uuid","description":"Reference id of a driver jar or native library uploaded via `POST /drivers/jars` or `POST /drivers/nativeLibs`."}}},"required":["className","type","jar"],"description":"This schema contains the allowed configuration files that can be uploaded to set up a JDBC connection type."},"AuthJdbc":{"title":"JDBC Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthNone"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthNone":"#/components/schemas/AuthNone"}}},"ConnectionLocalStorage":{"type":"object","title":"Shared Storage Connection","description":"Read-only access to a folder located on the Edge site. Used for technical lineage ingestion via OpenLineage (AWS Glue, Apache Airflow, OpenLineage).\n","properties":{"type":{"type":"string","pattern":"^ConnectionLocalStorage$","description":"Discriminator for shared storage connection"},"folder":{"description":"--target as specified in ./edgecli object folder-upload","type":"string","pattern":"^[\\w-]+$"}},"required":["type","folder"]},"ConnectionLooker":{"type":"object","title":"Looker Connection","description":"Looker connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionLooker$","description":"Discriminator for Looker Connection"},"url":{"description":"Looker URL","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthLooker"}},"required":["type","url","auth"]},"AuthLooker":{"title":"Looker Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthClientCredentials"}],"discriminator":{"propertyName":"type","mapping":{"AuthClientCredentials":"#/components/schemas/AuthClientCredentials"}}},"ConnectionMatillion":{"type":"object","title":"Matillion Connection","description":"Matillion connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionMatillion$","description":"Discriminator for Matillion Connection"},"url":{"description":"Matillion Url","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthMatillion"},"certFile":{"description":"Custom certificate","$ref":"#/components/schemas/ParameterEdgeArtifact"}},"required":["type","url","auth"]},"AuthMatillion":{"title":"Matillion Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthToken"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthToken":"#/components/schemas/AuthToken"}}},"ParameterEdgeArtifact":{"description":"References a non-sensitive artifact stored on the customer's Collibra Platform instance. Use for SSL certificates, driver libraries, and other files that do not need to stay within the customer's Edge site.\n","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueEdgeArtifactId"},{"$ref":"#/components/schemas/ValueVaultArtifact"}],"discriminator":{"propertyName":"type","mapping":{"ValueEdgeArtifactId":"#/components/schemas/ValueEdgeArtifactId","ValueVaultArtifact":"#/components/schemas/ValueVaultArtifact"}}},"ConnectionMicroStrategy":{"type":"object","title":"MicroStrategy Connection","description":"MicroStrategy connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionMicroStrategy$","description":"Discriminator for MicroStrategy Connection"},"url":{"description":"MicroStrategy URL","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthMicroStrategy"}},"required":["type","url","auth"]},"AuthMicroStrategy":{"title":"MicroStrategy Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthToken"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthToken":"#/components/schemas/AuthToken"}}},"ConnectionMlflow":{"type":"object","title":"MLflow Connection","description":"MLflow connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionMlflow$","description":"Discriminator for MLflow connection"},"url":{"description":"MLflow URL","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthMlflow"}},"required":["type","url","auth"]},"AuthMlflow":{"title":"MLflow Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthClientCredentialsWithTokenUrl"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthClientCredentialsWithTokenUrl":"#/components/schemas/AuthClientCredentialsWithTokenUrl"}}},"AuthClientCredentialsWithTokenUrl":{"title":"Client Credentials with Token URL Authentication","type":"object","description":"OAuth client credentials with token URL (client ID, secret, and token endpoint)","properties":{"type":{"type":"string","pattern":"^AuthClientCredentialsWithTokenUrl$"},"clientId":{"description":"Client ID","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret","$ref":"#/components/schemas/ParameterSecretString"},"tokenUrl":{"description":"The token URL of the OAuth client","$ref":"#/components/schemas/ParameterString"}},"required":["type","clientId","clientSecret","tokenUrl"]},"ConnectionPowerBI":{"type":"object","title":"Power BI Connection","description":"Power BI (SaaS) connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionPowerBI$","description":"Discriminator for Power BI Connection"},"tenantDomain":{"description":"Tenant Domain","$ref":"#/components/schemas/ParameterString"},"auth":{"description":"Authentication configuration for Power BI. Supports ServicePrincipal and ResourceOwnerPassword flows.\n","$ref":"#/components/schemas/AuthPowerBI"},"certFile":{"description":"Optional custom SSL/TLS certificate, in PEM format, used to establish a trusted HTTPS connection to the Power BI service. Provide this when the connection is routed through a proxy or gateway that presents a certificate signed by a custom or private Certificate Authority that is not trusted by default. The certificate is referenced as a non-sensitive artifact stored on the customer's Collibra Platform instance. When omitted, the system's default trusted CAs are used.\n","$ref":"#/components/schemas/ParameterEdgeArtifact"}},"required":["type","tenantDomain","auth"]},"AuthPowerBI":{"title":"Power BI Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthPowerBIResourceOwnerPassword"},{"$ref":"#/components/schemas/AuthPowerBIServicePrincipal"}],"discriminator":{"propertyName":"type","mapping":{"AuthPowerBIResourceOwnerPassword":"#/components/schemas/AuthPowerBIResourceOwnerPassword","AuthPowerBIServicePrincipal":"#/components/schemas/AuthPowerBIServicePrincipal"}}},"AuthPowerBIResourceOwnerPassword":{"title":"Power BI Resource Owner Password Credentials Authentication","type":"object","description":"Resource Owner Password Credentials authentication for Power BI","properties":{"type":{"type":"string","pattern":"^AuthPowerBIResourceOwnerPassword$"},"applicationId":{"description":"Application ID","$ref":"#/components/schemas/ParameterString"},"username":{"description":"Username","$ref":"#/components/schemas/ParameterString"},"passwordSecretKey":{"description":"Password/Secret key","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","applicationId","username","passwordSecretKey"]},"AuthPowerBIServicePrincipal":{"title":"Power BI Service Principal Authentication","type":"object","description":"Service Principal authentication for Power BI","properties":{"type":{"type":"string","pattern":"^AuthPowerBIServicePrincipal$"},"applicationId":{"description":"Application ID","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret for the service principal","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","applicationId","clientSecret"]},"ConnectionS3Compatible":{"type":"object","title":"S3-Compatible Connection","description":"Connection to a self-hosted or third-party S3-compatible storage service (e.g. MinIO, Ceph, NetApp StorageGRID).\n","properties":{"type":{"type":"string","pattern":"^ConnectionS3Compatible$","description":"Discriminator for S3-Compatible connection"},"endpoint":{"description":"URL of the S3-compatible storage endpoint, e.g. https://minio.example.com","$ref":"#/components/schemas/ParameterString"},"region":{"description":"Region identifier for the S3-compatible storage service.","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthS3Compatible"}},"required":["type","endpoint","auth"]},"AuthS3Compatible":{"title":"S3-Compatible Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthS3CompatibleAccessKey"}],"discriminator":{"propertyName":"type","mapping":{"AuthS3CompatibleAccessKey":"#/components/schemas/AuthS3CompatibleAccessKey"}}},"AuthS3CompatibleAccessKey":{"title":"S3-Compatible Access Key Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthS3CompatibleAccessKey$"},"accessKeyId":{"description":"Access key ID for the S3-compatible storage service.","$ref":"#/components/schemas/ParameterString"},"secretAccessKey":{"description":"Secret access key for the S3-compatible storage service.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","accessKeyId","secretAccessKey"]},"ConnectionSapAICore":{"type":"object","title":"SAP AI Core Connection","description":"SAP AI Core connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionSapAICore$","description":"Discriminator for SAP AI Core connection"},"url":{"description":"SAP AI Core URL","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthSapAICore"}},"required":["type","url","auth"]},"AuthSapAICore":{"title":"SAP AI Core Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthClientCredentialsWithTokenUrl"}],"discriminator":{"propertyName":"type","mapping":{"AuthClientCredentialsWithTokenUrl":"#/components/schemas/AuthClientCredentialsWithTokenUrl"}}},"ConnectionSapDatasphereCatalog":{"type":"object","title":"SAP Datasphere Catalog Connection","description":"SAP Datasphere Catalog connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionSapDatasphereCatalog$","description":"Discriminator for SAP Datasphere Catalog connection"},"url":{"description":"SAP Datasphere Catalog URL","$ref":"#/components/schemas/ParameterString"},"datasphereCatalogAuth":{"description":"OAuth client credentials for ingesting the SAP Datasphere Catalog.","$ref":"#/components/schemas/AuthSapDatasphereCatalog"},"dataProductsAuth":{"description":"Optional OAuth client credentials for ingesting SAP Data Products. When omitted, SAP Data Products are not ingested.","$ref":"#/components/schemas/AuthClientCredentials"}},"required":["type","url","datasphereCatalogAuth"]},"AuthSapDatasphereCatalog":{"title":"SAP Datasphere Catalog Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthClientCredentialsWithTokenUrl"}],"discriminator":{"propertyName":"type","mapping":{"AuthClientCredentialsWithTokenUrl":"#/components/schemas/AuthClientCredentialsWithTokenUrl"}}},"ConnectionSigma":{"type":"object","title":"Sigma Connection","description":"Sigma connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionSigma$","description":"Discriminator for Sigma connection"},"url":{"description":"Sigma instance base URL, e.g. https://aws-api.sigmacomputing.com","$ref":"#/components/schemas/ParameterString"},"tenantUrl":{"description":"Tenant-specific URL, e.g. https://app.sigmacomputing.com/your-tenant","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthSigma"}},"required":["type","url","tenantUrl","auth"]},"AuthSigma":{"title":"Sigma Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthClientCredentials"}],"discriminator":{"propertyName":"type","mapping":{"AuthClientCredentials":"#/components/schemas/AuthClientCredentials"}}},"ConnectionSnowflake":{"type":"object","title":"Snowflake Connection","description":"Snowflake connection.","properties":{"type":{"type":"string","pattern":"^ConnectionSnowflake$","description":"Discriminator for Snowflake connection."},"account":{"description":"The Account Identifier for the Snowflake account. This often includes cloud region information (e.g., xy123456.eu-central-1).","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthSnowflake"},"role":{"description":"The role to use in the Snowflake session.","$ref":"#/components/schemas/ParameterString"},"warehouse":{"description":"The name of the Snowflake warehouse. Defaults to the user's default warehouse if not specified.","$ref":"#/components/schemas/ParameterString"}},"required":["type","account","auth"]},"AuthSnowflake":{"title":"Snowflake Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthSnowflakeKeyPair"},{"$ref":"#/components/schemas/AuthSnowflakePat"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthSnowflakeKeyPair":"#/components/schemas/AuthSnowflakeKeyPair","AuthSnowflakePat":"#/components/schemas/AuthSnowflakePat"}}},"AuthSnowflakeKeyPair":{"title":"Snowflake Key Pair Authentication","type":"object","description":"Key pair authentication for Snowflake.","properties":{"type":{"type":"string","pattern":"^AuthSnowflakeKeyPair$"},"username":{"description":"The username to authenticate against the Snowflake account.","$ref":"#/components/schemas/ParameterString"},"privateKeyEdgeArtifact":{"description":"The private key artifact in P8 format for key pair authentication.","$ref":"#/components/schemas/ParameterSecretEdgeArtifact"},"privateKeyPwd":{"description":"The passphrase for the private key, if it is encrypted.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","username","privateKeyEdgeArtifact"]},"ParameterSecretEdgeArtifact":{"description":"References a sensitive artifact stored on the Edge site. The file content never leaves the Edge site cluster. Use for private keys and other sensitive artifacts.\n","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueSecretEdgeArtifactId"},{"$ref":"#/components/schemas/ValueVaultArtifact"}],"discriminator":{"propertyName":"type","mapping":{"ValueSecretEdgeArtifactId":"#/components/schemas/ValueSecretEdgeArtifactId","ValueVaultArtifact":"#/components/schemas/ValueVaultArtifact"}}},"AuthSnowflakePat":{"title":"Snowflake Programmatic Access Token Authentication","type":"object","description":"Programmatic Access Token (PAT) authentication for Snowflake.","properties":{"type":{"type":"string","pattern":"^AuthSnowflakePat$"},"programmaticAccessToken":{"description":"Programmatic Access Token generated in Snowflake.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","programmaticAccessToken"]},"ConnectionSsrs":{"type":"object","title":"Microsoft SSRS/PBRS Connection","description":"Microsoft SSRS/PBRS connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionSsrs$","description":"Discriminator for Microsoft SSRS/PBRS Connection"},"url":{"description":"Microsoft SSRS/PBRS URL","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthSsrs"}},"required":["type","url","auth"]},"AuthSsrs":{"title":"SSRS Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic"}}},"ConnectionTableau":{"type":"object","title":"Tableau Connection","description":"Tableau connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionTableau$","description":"Discriminator for Tableau Connection"},"url":{"description":"URL of the Tableau Server or Tableau Cloud site.","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthTableau"},"certFile":{"description":"Custom certificate","$ref":"#/components/schemas/ParameterEdgeArtifact"}},"required":["type","url","auth"]},"AuthTableau":{"title":"Tableau Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthTableauToken"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthTableauToken":"#/components/schemas/AuthTableauToken"}}},"AuthTableauToken":{"title":"Tableau Token Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthTableauToken$"},"tokenName":{"description":"Name of the service/account token (any unique meaningful name can be used)","$ref":"#/components/schemas/ParameterString"},"tokenSecret":{"description":"Value of the service/account token","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","tokenName","tokenSecret"]},"ConnectionThoughtSpot":{"type":"object","title":"ThoughtSpot Connection","description":"ThoughtSpot connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionThoughtSpot$","description":"Discriminator for ThoughtSpot connection"},"url":{"description":"ThoughtSpot instance base URL, e.g. https://customer.thoughtspot.cloud","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthThoughtSpot"}},"required":["type","url","auth"]},"AuthThoughtSpot":{"title":"ThoughtSpot Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic"}}}}}} ``` ## The ConnectionListResponse object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"ConnectionListResponse":{"type":"object","required":["results"],"properties":{"nextCursor":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ConnectionResponse"}}},"description":"This is the paginated response for data source connection management endpoints."},"ConnectionResponse":{"type":"object","required":["id","name","edgeSiteId","properties","createdOn","lastModifiedOn","testConnectionSupported"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string"},"edgeSiteId":{"type":"string","format":"uuid"},"vaultId":{"type":"string","format":"uuid","description":"Associated vault id, if configured"},"createdOn":{"type":"string","format":"date-time"},"lastModifiedOn":{"type":"string","format":"date-time"},"testConnectionSupported":{"type":"boolean","readOnly":true,"description":"Indicates whether this connection type supports the test connection operation. Only connections with `testConnectionSupported: true` can be used with `POST /sites/{siteId}/connections/{connectionId}/test`.\n"},"properties":{"$ref":"#/components/schemas/ConnectionProperties"}},"description":"Response body for data source connection management endpoints."},"ConnectionProperties":{"oneOf":[{"$ref":"#/components/schemas/ConnectionAws"},{"$ref":"#/components/schemas/ConnectionAzure"},{"$ref":"#/components/schemas/ConnectionDatabricks"},{"$ref":"#/components/schemas/ConnectionDbt"},{"$ref":"#/components/schemas/ConnectionGcp"},{"$ref":"#/components/schemas/ConnectionGit"},{"$ref":"#/components/schemas/ConnectionHttp"},{"$ref":"#/components/schemas/ConnectionIics"},{"$ref":"#/components/schemas/ConnectionJdbc"},{"$ref":"#/components/schemas/ConnectionLocalStorage"},{"$ref":"#/components/schemas/ConnectionLooker"},{"$ref":"#/components/schemas/ConnectionMatillion"},{"$ref":"#/components/schemas/ConnectionMicroStrategy"},{"$ref":"#/components/schemas/ConnectionMlflow"},{"$ref":"#/components/schemas/ConnectionPowerBI"},{"$ref":"#/components/schemas/ConnectionS3Compatible"},{"$ref":"#/components/schemas/ConnectionSapAICore"},{"$ref":"#/components/schemas/ConnectionSapDatasphereCatalog"},{"$ref":"#/components/schemas/ConnectionSigma"},{"$ref":"#/components/schemas/ConnectionSnowflake"},{"$ref":"#/components/schemas/ConnectionSsrs"},{"$ref":"#/components/schemas/ConnectionTableau"},{"$ref":"#/components/schemas/ConnectionThoughtSpot"}],"discriminator":{"propertyName":"type","mapping":{"ConnectionAws":"#/components/schemas/ConnectionAws","ConnectionAzure":"#/components/schemas/ConnectionAzure","ConnectionDatabricks":"#/components/schemas/ConnectionDatabricks","ConnectionDbt":"#/components/schemas/ConnectionDbt","ConnectionGcp":"#/components/schemas/ConnectionGcp","ConnectionGit":"#/components/schemas/ConnectionGit","ConnectionHttp":"#/components/schemas/ConnectionHttp","ConnectionIics":"#/components/schemas/ConnectionIics","ConnectionJdbc":"#/components/schemas/ConnectionJdbc","ConnectionLocalStorage":"#/components/schemas/ConnectionLocalStorage","ConnectionLooker":"#/components/schemas/ConnectionLooker","ConnectionMatillion":"#/components/schemas/ConnectionMatillion","ConnectionMicroStrategy":"#/components/schemas/ConnectionMicroStrategy","ConnectionMlflow":"#/components/schemas/ConnectionMlflow","ConnectionPowerBI":"#/components/schemas/ConnectionPowerBI","ConnectionS3Compatible":"#/components/schemas/ConnectionS3Compatible","ConnectionSapAICore":"#/components/schemas/ConnectionSapAICore","ConnectionSapDatasphereCatalog":"#/components/schemas/ConnectionSapDatasphereCatalog","ConnectionSigma":"#/components/schemas/ConnectionSigma","ConnectionSnowflake":"#/components/schemas/ConnectionSnowflake","ConnectionSsrs":"#/components/schemas/ConnectionSsrs","ConnectionTableau":"#/components/schemas/ConnectionTableau","ConnectionThoughtSpot":"#/components/schemas/ConnectionThoughtSpot"}}},"ConnectionAws":{"type":"object","title":"AWS Connection","description":"AWS connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionAws$","description":"Discriminator for AWS connection"},"auth":{"$ref":"#/components/schemas/AuthAws"},"parameters":{"$ref":"#/components/schemas/ParameterGenericMap"}},"required":["type","auth"]},"AuthAws":{"title":"AWS Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthAwsEc2"},{"$ref":"#/components/schemas/AuthAwsIam"}],"discriminator":{"propertyName":"type","mapping":{"AuthAwsEc2":"#/components/schemas/AuthAwsEc2","AuthAwsIam":"#/components/schemas/AuthAwsIam"}}},"AuthAwsEc2":{"title":"AWS EC2 Instance Profile Authentication","type":"object","description":"Authenticate via the IAM role attached to the EC2 instance running the Edge site. No credentials are configured on the connection.","properties":{"type":{"type":"string","pattern":"^AuthAwsEc2$"}},"required":["type"]},"AuthAwsIam":{"title":"AWS IAM Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthAwsIam$"},"awsAccessKeyId":{"description":"AWS Access Key ID","$ref":"#/components/schemas/ParameterString"},"awsSecretKey":{"description":"AWS Secret Access Key","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","awsAccessKeyId","awsSecretKey"]},"ParameterString":{"description":"String value that is a plain text value or a vault secret that resolves to a string value.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueString":{"title":"String Value","type":"object","required":["type","value"],"properties":{"type":{"type":"string","pattern":"^ValueString$"},"value":{"type":"string","minLength":1,"maxLength":4000,"pattern":".*\\S.*"}},"description":"Contains a series of characters that comprises a string value."},"ValueVaultString":{"title":"VaultStringReference","description":"Reference to a vault-stored secret that resolves to a string value. Use this instead of `ValueString` when the value should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultString$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"VaultKeys":{"title":"Vault Keys","description":"Vault reference parameter for HashiCorp, CyberArk, AWS Secrets Manager, Azure Key Vault and Google Secret Manager.","type":"object","oneOf":[{"$ref":"#/components/schemas/VaultKeyAWSSecretsManager"},{"$ref":"#/components/schemas/VaultKeyAzureKeyVaultSecret"},{"$ref":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery"},{"$ref":"#/components/schemas/VaultKeyGCPSecretManager"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultDatabase"},{"$ref":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}],"discriminator":{"propertyName":"type","mapping":{"VaultKeyAWSSecretsManager":"#/components/schemas/VaultKeyAWSSecretsManager","VaultKeyAzureKeyVaultSecret":"#/components/schemas/VaultKeyAzureKeyVaultSecret","VaultKeyCyberArkCredentialProviderQuery":"#/components/schemas/VaultKeyCyberArkCredentialProviderQuery","VaultKeyGCPSecretManager":"#/components/schemas/VaultKeyGCPSecretManager","VaultKeyHashiCorpVaultDatabase":"#/components/schemas/VaultKeyHashiCorpVaultDatabase","VaultKeyHashiCorpVaultKeyValue":"#/components/schemas/VaultKeyHashiCorpVaultKeyValue"}}},"VaultKeyAWSSecretsManager":{"title":"AWS Secrets Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAWSSecretsManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The name of the secret in your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"Required only when the secret stored in AWS Secrets Manager is a JSON object; it selects which JSON key to use.\n\nFor example, if the secret is `{\"pass1\": \"my-password\", \"pass2\": \"my-password2\"}` and you want the value of `pass1`, set `secretName` to the AWS secret name (e.g. `edge-db-customer`) and `field` to `pass1`.\n\nLeave `field` empty when the secret is stored as a plain string value.\n"}}},"VaultKeyAzureKeyVaultSecret":{"title":"Azure Key Vault Secret Reference","type":"object","required":["type","secretName","vaultName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyAzureKeyVaultSecret$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."},"vaultName":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the Azure Key Vault that contains the secret."}}},"VaultKeyCyberArkCredentialProviderQuery":{"title":"CyberArk Credential Provider Query Reference","type":"object","required":["type","query"],"properties":{"type":{"type":"string","pattern":"^VaultKeyCyberArkCredentialProviderQuery$"},"query":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The query must be a string containing the properties required to identify the secret. Each property must be separated by a semicolon (`;`).\n\nFor example: `Safe=;Folder=;Object=`\n\nIf a property is a folder with sub-folders, use a backslash (`\\`) to define the folder path. For example: `Folder=Root\\Top Secrets\\More Secrets`\n"}}},"VaultKeyGCPSecretManager":{"title":"Google Cloud Secret Manager Reference","type":"object","required":["type","secretName"],"properties":{"type":{"type":"string","pattern":"^VaultKeyGCPSecretManager$"},"secretName":{"type":"string","pattern":".*\\S.*","maxLength":256,"description":"The name of the secret in your vault where the value is stored."}}},"VaultKeyHashiCorpVaultDatabase":{"title":"HashiCorp Vault Database Reference","type":"object","required":["type","enginePath","role","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultDatabase$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"role":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"If your Secret Engine Type is Database, enter the role specified in the Database engine."},"field":{"type":"string","pattern":"^(username|password)$","description":"Allowed values: username, password"}}},"VaultKeyHashiCorpVaultKeyValue":{"title":"HashiCorp Key-Value Secret Reference","type":"object","required":["type","enginePath","secretPath","field"],"properties":{"type":{"type":"string","pattern":"^VaultKeyHashiCorpVaultKeyValue$"},"enginePath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The engine path to your vault where the value is stored."},"secretPath":{"type":"string","pattern":".*\\S.*","maxLength":100,"description":"The secret path to your vault where the value is stored."},"field":{"type":"string","pattern":".*\\S.*","maxLength":128,"description":"The name of the field in the HashiCorp Key-Value secret whose value should be retrieved."}}},"ParameterSecretString":{"description":"A secret string value that is a plain text value, a redacted value from reading a secret stored on an Edge site, or a string value retrieved from a vault.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueRedacted":"#/components/schemas/ValueRedacted","ValueString":"#/components/schemas/ValueString","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueRedacted":{"title":"Redacted Value","description":"Returned when a secret value is stored on the Edge site and is not accessible via the API. On create and update, use ValueString to set the value. To clear an existing secret, omit the field from the request body.\n","type":"object","required":["type"],"properties":{"type":{"type":"string","pattern":"^ValueRedacted$"}}},"ParameterGenericMap":{"type":"object","description":"Map of parameters for connections used to pass additional configuration.","additionalProperties":{"$ref":"#/components/schemas/ParameterGeneric"}},"ParameterGeneric":{"title":"Generic Parameter","description":"A parameter value for use in a data source connection parameter configuration.","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueEdgeArtifactId"},{"$ref":"#/components/schemas/ValueRedacted"},{"$ref":"#/components/schemas/ValueSecretEdgeArtifactId"},{"$ref":"#/components/schemas/ValueString"},{"$ref":"#/components/schemas/ValueVaultArtifact"},{"$ref":"#/components/schemas/ValueVaultString"}],"discriminator":{"propertyName":"type","mapping":{"ValueEdgeArtifactId":"#/components/schemas/ValueEdgeArtifactId","ValueRedacted":"#/components/schemas/ValueRedacted","ValueSecretEdgeArtifactId":"#/components/schemas/ValueSecretEdgeArtifactId","ValueString":"#/components/schemas/ValueString","ValueVaultArtifact":"#/components/schemas/ValueVaultArtifact","ValueVaultString":"#/components/schemas/ValueVaultString"}}},"ValueEdgeArtifactId":{"title":"Edge Artifact ID","description":"References a non-sensitive artifact stored on the Collibra instance and uploaded via `POST /artifacts`. Use for files such as SSL certificates and driver libraries.\n","type":"object","required":["type","edgeArtifactId"],"properties":{"type":{"type":"string","pattern":"^ValueEdgeArtifactId$"},"edgeArtifactId":{"type":"string","format":"uuid","description":"Reference id of the artifact uploaded via `POST /artifacts`."}}},"ValueSecretEdgeArtifactId":{"title":"Secret Edge Artifact ID","description":"References a secret artifact stored on the Edge site and uploaded via `POST /sites/{siteId}/secretArtifacts`. The file content never leaves the Edge site cluster. Use for private keys and other sensitive artifacts. Each secret artifact can only be referenced by a single connection and cannot be reused.\n","type":"object","required":["type","secretEdgeArtifactId"],"properties":{"type":{"type":"string","pattern":"^ValueSecretEdgeArtifactId$"},"secretEdgeArtifactId":{"type":"string","maxLength":512,"description":"The `id` value returned by `POST /sites/{siteId}/secretArtifacts`.\n"}}},"ValueVaultArtifact":{"title":"VaultArtifactReference","description":"Reference to a vault-stored secret that resolves to a file artifact. Use this instead of `EdgeArtifact` when the file should be retrieved from a vault at runtime.","type":"object","properties":{"type":{"type":"string","pattern":"^ValueVaultArtifact$"},"key":{"$ref":"#/components/schemas/VaultKeys"}},"required":["type","key"]},"ConnectionAzure":{"type":"object","title":"Azure Connection","description":"Azure connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionAzure$","description":"Discriminator for Azure connection"},"usGovernmentCloudHost":{"description":"Indicates whether Azure US Government Cloud is the host for Microsoft Entra.","type":"boolean","default":false},"auth":{"$ref":"#/components/schemas/AuthAzure"}},"required":["type","auth"]},"AuthAzure":{"title":"Azure Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthAzureServicePrincipal"}],"discriminator":{"propertyName":"type","mapping":{"AuthAzureServicePrincipal":"#/components/schemas/AuthAzureServicePrincipal"}}},"AuthAzureServicePrincipal":{"type":"object","title":"Azure Service Principal Authentication","properties":{"type":{"type":"string","pattern":"^AuthAzureServicePrincipal$"},"clientId":{"description":"The ID of the Service Principal used to connect to Azure","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"The Secret Key for the Service Principal","$ref":"#/components/schemas/ParameterSecretString"},"tenantId":{"description":"The Tenant ID of your Azure AD","$ref":"#/components/schemas/ParameterString"}},"required":["type","clientId","clientSecret","tenantId"]},"ConnectionDatabricks":{"type":"object","title":"Databricks Connection","description":"Databricks connection.","properties":{"type":{"type":"string","pattern":"^ConnectionDatabricks$","description":"Discriminator for Databricks connection."},"workspaceUrl":{"description":"Workspace URL on Databricks.","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthDatabricks"}},"required":["type","workspaceUrl","auth"]},"AuthDatabricks":{"title":"Databricks Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthClientCredentials"},{"$ref":"#/components/schemas/AuthDatabricksEntraId"},{"$ref":"#/components/schemas/AuthToken"}],"discriminator":{"propertyName":"type","mapping":{"AuthClientCredentials":"#/components/schemas/AuthClientCredentials","AuthDatabricksEntraId":"#/components/schemas/AuthDatabricksEntraId","AuthToken":"#/components/schemas/AuthToken"}}},"AuthClientCredentials":{"title":"Client Credentials Authentication","type":"object","description":"Generic client credentials (client ID + secret) authentication, reusable across connection types.","properties":{"type":{"type":"string","pattern":"^AuthClientCredentials$"},"clientId":{"description":"Client ID","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","clientId","clientSecret"]},"AuthDatabricksEntraId":{"title":"Databricks Microsoft Entra ID Authentication","type":"object","description":"Microsoft Entra ID (Azure AD) authentication for Databricks.","properties":{"type":{"type":"string","pattern":"^AuthDatabricksEntraId$"},"clientId":{"description":"Client ID of the Microsoft Entra ID service principal.","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret of the Microsoft Entra ID service principal.","$ref":"#/components/schemas/ParameterSecretString"},"tenantId":{"description":"Tenant ID for Microsoft Entra ID authentication.","$ref":"#/components/schemas/ParameterString"}},"required":["type","clientId","clientSecret","tenantId"]},"AuthToken":{"title":"Token Authentication","type":"object","description":"Generic single-token authentication, reusable across connection types.","properties":{"type":{"type":"string","pattern":"^AuthToken$"},"token":{"description":"Token value for authentication.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","token"]},"ConnectionDbt":{"type":"object","title":"dbt Connection","description":"dbt connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionDbt$","description":"Discriminator for dbt Connection"},"adminUrl":{"description":"Optional dbt admin API URL. Defaults to https://cloud.getdbt.com/api/v2","$ref":"#/components/schemas/ParameterString"},"metadataUrl":{"description":"Optional dbt metadata URL. Defaults to https://metadata.cloud.getdbt.com/graphql","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthDbt"}},"required":["type","auth"]},"AuthDbt":{"title":"dbt Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthDbtToken"}],"discriminator":{"propertyName":"type","mapping":{"AuthDbtToken":"#/components/schemas/AuthDbtToken"}}},"AuthDbtToken":{"title":"dbt Token Authentication","type":"object","description":"A dbt Cloud service token with the required permissions, used for authentication.","properties":{"type":{"type":"string","pattern":"^AuthDbtToken$"},"tokenName":{"description":"Name of the service/account token (any unique meaningful name can be used)","$ref":"#/components/schemas/ParameterString"},"tokenValue":{"description":"Value of the service/account token (the copied value from dbt Cloud)","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","tokenName","tokenValue"]},"ConnectionGcp":{"type":"object","title":"GCP Connection","description":"GCP connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionGcp$","description":"Discriminator for GCP Connection"},"auth":{"$ref":"#/components/schemas/AuthGcp"},"parameters":{"$ref":"#/components/schemas/ParameterGenericMap"}},"required":["type","auth"]},"AuthGcp":{"title":"GCP Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthGcpServiceAccount"},{"$ref":"#/components/schemas/AuthGcpWif"},{"$ref":"#/components/schemas/AuthGcpWifGke"}],"discriminator":{"propertyName":"type","mapping":{"AuthGcpServiceAccount":"#/components/schemas/AuthGcpServiceAccount","AuthGcpWif":"#/components/schemas/AuthGcpWif","AuthGcpWifGke":"#/components/schemas/AuthGcpWifGke"}}},"AuthGcpServiceAccount":{"title":"GCP Service Account Authentication","type":"object","description":"GCP Service Account authentication (full JSON key)","properties":{"type":{"type":"string","pattern":"^AuthGcpServiceAccount$"},"credentialsJson":{"description":"Full JSON key for the service account","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","credentialsJson"]},"AuthGcpWif":{"title":"GCP Workload Identity Federation (WIF) Authentication","type":"object","description":"Workload Identity Federation (WIF) - token URL or token","properties":{"type":{"type":"string","pattern":"^AuthGcpWif$"},"tokenOrTokenUrl":{"description":"Token URL or token for WIF","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","tokenOrTokenUrl"]},"AuthGcpWifGke":{"title":"GCP Workload Identity Federation (WIF) using GKE Authentication","type":"object","description":"Workload Identity Federation (WIF) using GKE - credentials from GKE, leave blank","properties":{"type":{"type":"string","pattern":"^AuthGcpWifGke$"}},"required":["type"]},"ConnectionGit":{"type":"object","title":"Git Connection","description":"Connection to a Git repository\n","properties":{"type":{"type":"string","pattern":"^ConnectionGit$","description":"Discriminator for Git connection"},"repositoryUrl":{"description":"HTTPS URL of the Git repository root, e.g. https://github.com/org/repo.git","$ref":"#/components/schemas/ParameterString"},"subfolder":{"description":"Path to a specific subfolder within the repository, e.g. src or projects/analytics.","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthGit"}},"required":["type","repositoryUrl","auth"]},"AuthGit":{"title":"Git Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthGitAccessToken"}],"discriminator":{"propertyName":"type","mapping":{"AuthGitAccessToken":"#/components/schemas/AuthGitAccessToken"}}},"AuthGitAccessToken":{"title":"Git Access Token Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthGitAccessToken$"},"username":{"description":"Username for authentication. Required for Bitbucket repositories.","$ref":"#/components/schemas/ParameterString"},"accessToken":{"description":"Personal access token for authenticating with the Git repository.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","accessToken"]},"ConnectionHttp":{"type":"object","title":"HTTP Connection","description":"Allows workflows to communicate with other HTTP based systems.\n","properties":{"type":{"type":"string","pattern":"^ConnectionHttp$","description":"Discriminator for HTTP connection"},"host":{"description":"The protocol and domain name of the server to connect to, for example, https://api.example.com","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthHttp"},"testConnectionPath":{"description":"The path for testing this connection with a GET call, for example, /v1/health.","$ref":"#/components/schemas/ParameterString"}},"required":["type","host"]},"AuthHttp":{"title":"HTTP Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthNone"},{"$ref":"#/components/schemas/AuthOAuth2"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthNone":"#/components/schemas/AuthNone","AuthOAuth2":"#/components/schemas/AuthOAuth2"}}},"AuthBasic":{"title":"Basic Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthBasic$"},"username":{"description":"Username","$ref":"#/components/schemas/ParameterString"},"password":{"description":"Password","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","username","password"]},"AuthNone":{"title":"No Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthNone$"}},"required":["type"]},"AuthOAuth2":{"title":"OAuth 2.0 Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthOAuth2$"},"clientId":{"description":"Client id","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret","$ref":"#/components/schemas/ParameterSecretString"},"accessTokenUri":{"description":"Access token URI","$ref":"#/components/schemas/ParameterString"},"scopes":{"description":"Scopes","$ref":"#/components/schemas/ParameterString"}},"required":["type","clientId","clientSecret","accessTokenUri"]},"ConnectionIics":{"type":"object","title":"Informatica Intelligent Cloud Services (IICS) Connection","description":"IICS connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionIics$","description":"Discriminator for Informatica Intelligent Cloud Services (IICS) Connection"},"url":{"description":"IICS Url","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthIics"}},"required":["type","url","auth"]},"AuthIics":{"title":"IICS Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic"}}},"ConnectionJdbc":{"title":"JDBC Connection","type":"object","required":["type","driver","connectionString"],"properties":{"type":{"type":"string","pattern":"^ConnectionJdbc$","description":"Discriminator for JDBC connection types."},"driver":{"$ref":"#/components/schemas/JdbcDriver"},"connectionString":{"$ref":"#/components/schemas/ParameterString","description":"JDBC connection string, e.g. \"jdbc:mysql://localhost:3306/mydb\""},"auth":{"description":"Authentication configuration. When omitted, defaults to AuthNone.","$ref":"#/components/schemas/AuthJdbc"},"parameters":{"description":"Additional JDBC connection properties, such as SSL settings, timeouts, etc. These are passed as key-value pairs in the connection string.","allOf":[{"$ref":"#/components/schemas/ParameterGenericMap"}]}}},"JdbcDriver":{"type":"object","description":"JDBC driver configuration (`JdbcDriverDirect`). Specify the driver jar, an optional classpath, and the fully qualified driver class name.","oneOf":[{"$ref":"#/components/schemas/JdbcDriverDirect"}],"discriminator":{"propertyName":"type","mapping":{"JdbcDriverDirect":"#/components/schemas/JdbcDriverDirect"}}},"JdbcDriverDirect":{"title":"Direct JDBC Driver","type":"object","properties":{"type":{"type":"string","pattern":"^JdbcDriverDirect$"},"className":{"type":"string","description":"Fully qualified class name of the JDBC driver (e.g. \"org.postgresql.Driver\", \"com.mysql.cj.jdbc.Driver\", etc.).","maxLength":100,"pattern":"^[a-zA-Z0-9._$]+$"},"jar":{"type":"string","format":"uuid","description":"Reference id of the driver jar uploaded via `POST /drivers/jars`."},"additionalClasspathFiles":{"type":"array","maxItems":10,"items":{"type":"string","format":"uuid","description":"Reference id of a driver jar or native library uploaded via `POST /drivers/jars` or `POST /drivers/nativeLibs`."}}},"required":["className","type","jar"],"description":"This schema contains the allowed configuration files that can be uploaded to set up a JDBC connection type."},"AuthJdbc":{"title":"JDBC Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthNone"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthNone":"#/components/schemas/AuthNone"}}},"ConnectionLocalStorage":{"type":"object","title":"Shared Storage Connection","description":"Read-only access to a folder located on the Edge site. Used for technical lineage ingestion via OpenLineage (AWS Glue, Apache Airflow, OpenLineage).\n","properties":{"type":{"type":"string","pattern":"^ConnectionLocalStorage$","description":"Discriminator for shared storage connection"},"folder":{"description":"--target as specified in ./edgecli object folder-upload","type":"string","pattern":"^[\\w-]+$"}},"required":["type","folder"]},"ConnectionLooker":{"type":"object","title":"Looker Connection","description":"Looker connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionLooker$","description":"Discriminator for Looker Connection"},"url":{"description":"Looker URL","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthLooker"}},"required":["type","url","auth"]},"AuthLooker":{"title":"Looker Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthClientCredentials"}],"discriminator":{"propertyName":"type","mapping":{"AuthClientCredentials":"#/components/schemas/AuthClientCredentials"}}},"ConnectionMatillion":{"type":"object","title":"Matillion Connection","description":"Matillion connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionMatillion$","description":"Discriminator for Matillion Connection"},"url":{"description":"Matillion Url","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthMatillion"},"certFile":{"description":"Custom certificate","$ref":"#/components/schemas/ParameterEdgeArtifact"}},"required":["type","url","auth"]},"AuthMatillion":{"title":"Matillion Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthToken"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthToken":"#/components/schemas/AuthToken"}}},"ParameterEdgeArtifact":{"description":"References a non-sensitive artifact stored on the customer's Collibra Platform instance. Use for SSL certificates, driver libraries, and other files that do not need to stay within the customer's Edge site.\n","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueEdgeArtifactId"},{"$ref":"#/components/schemas/ValueVaultArtifact"}],"discriminator":{"propertyName":"type","mapping":{"ValueEdgeArtifactId":"#/components/schemas/ValueEdgeArtifactId","ValueVaultArtifact":"#/components/schemas/ValueVaultArtifact"}}},"ConnectionMicroStrategy":{"type":"object","title":"MicroStrategy Connection","description":"MicroStrategy connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionMicroStrategy$","description":"Discriminator for MicroStrategy Connection"},"url":{"description":"MicroStrategy URL","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthMicroStrategy"}},"required":["type","url","auth"]},"AuthMicroStrategy":{"title":"MicroStrategy Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthToken"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthToken":"#/components/schemas/AuthToken"}}},"ConnectionMlflow":{"type":"object","title":"MLflow Connection","description":"MLflow connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionMlflow$","description":"Discriminator for MLflow connection"},"url":{"description":"MLflow URL","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthMlflow"}},"required":["type","url","auth"]},"AuthMlflow":{"title":"MLflow Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthClientCredentialsWithTokenUrl"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthClientCredentialsWithTokenUrl":"#/components/schemas/AuthClientCredentialsWithTokenUrl"}}},"AuthClientCredentialsWithTokenUrl":{"title":"Client Credentials with Token URL Authentication","type":"object","description":"OAuth client credentials with token URL (client ID, secret, and token endpoint)","properties":{"type":{"type":"string","pattern":"^AuthClientCredentialsWithTokenUrl$"},"clientId":{"description":"Client ID","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret","$ref":"#/components/schemas/ParameterSecretString"},"tokenUrl":{"description":"The token URL of the OAuth client","$ref":"#/components/schemas/ParameterString"}},"required":["type","clientId","clientSecret","tokenUrl"]},"ConnectionPowerBI":{"type":"object","title":"Power BI Connection","description":"Power BI (SaaS) connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionPowerBI$","description":"Discriminator for Power BI Connection"},"tenantDomain":{"description":"Tenant Domain","$ref":"#/components/schemas/ParameterString"},"auth":{"description":"Authentication configuration for Power BI. Supports ServicePrincipal and ResourceOwnerPassword flows.\n","$ref":"#/components/schemas/AuthPowerBI"},"certFile":{"description":"Optional custom SSL/TLS certificate, in PEM format, used to establish a trusted HTTPS connection to the Power BI service. Provide this when the connection is routed through a proxy or gateway that presents a certificate signed by a custom or private Certificate Authority that is not trusted by default. The certificate is referenced as a non-sensitive artifact stored on the customer's Collibra Platform instance. When omitted, the system's default trusted CAs are used.\n","$ref":"#/components/schemas/ParameterEdgeArtifact"}},"required":["type","tenantDomain","auth"]},"AuthPowerBI":{"title":"Power BI Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthPowerBIResourceOwnerPassword"},{"$ref":"#/components/schemas/AuthPowerBIServicePrincipal"}],"discriminator":{"propertyName":"type","mapping":{"AuthPowerBIResourceOwnerPassword":"#/components/schemas/AuthPowerBIResourceOwnerPassword","AuthPowerBIServicePrincipal":"#/components/schemas/AuthPowerBIServicePrincipal"}}},"AuthPowerBIResourceOwnerPassword":{"title":"Power BI Resource Owner Password Credentials Authentication","type":"object","description":"Resource Owner Password Credentials authentication for Power BI","properties":{"type":{"type":"string","pattern":"^AuthPowerBIResourceOwnerPassword$"},"applicationId":{"description":"Application ID","$ref":"#/components/schemas/ParameterString"},"username":{"description":"Username","$ref":"#/components/schemas/ParameterString"},"passwordSecretKey":{"description":"Password/Secret key","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","applicationId","username","passwordSecretKey"]},"AuthPowerBIServicePrincipal":{"title":"Power BI Service Principal Authentication","type":"object","description":"Service Principal authentication for Power BI","properties":{"type":{"type":"string","pattern":"^AuthPowerBIServicePrincipal$"},"applicationId":{"description":"Application ID","$ref":"#/components/schemas/ParameterString"},"clientSecret":{"description":"Client secret for the service principal","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","applicationId","clientSecret"]},"ConnectionS3Compatible":{"type":"object","title":"S3-Compatible Connection","description":"Connection to a self-hosted or third-party S3-compatible storage service (e.g. MinIO, Ceph, NetApp StorageGRID).\n","properties":{"type":{"type":"string","pattern":"^ConnectionS3Compatible$","description":"Discriminator for S3-Compatible connection"},"endpoint":{"description":"URL of the S3-compatible storage endpoint, e.g. https://minio.example.com","$ref":"#/components/schemas/ParameterString"},"region":{"description":"Region identifier for the S3-compatible storage service.","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthS3Compatible"}},"required":["type","endpoint","auth"]},"AuthS3Compatible":{"title":"S3-Compatible Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthS3CompatibleAccessKey"}],"discriminator":{"propertyName":"type","mapping":{"AuthS3CompatibleAccessKey":"#/components/schemas/AuthS3CompatibleAccessKey"}}},"AuthS3CompatibleAccessKey":{"title":"S3-Compatible Access Key Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthS3CompatibleAccessKey$"},"accessKeyId":{"description":"Access key ID for the S3-compatible storage service.","$ref":"#/components/schemas/ParameterString"},"secretAccessKey":{"description":"Secret access key for the S3-compatible storage service.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","accessKeyId","secretAccessKey"]},"ConnectionSapAICore":{"type":"object","title":"SAP AI Core Connection","description":"SAP AI Core connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionSapAICore$","description":"Discriminator for SAP AI Core connection"},"url":{"description":"SAP AI Core URL","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthSapAICore"}},"required":["type","url","auth"]},"AuthSapAICore":{"title":"SAP AI Core Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthClientCredentialsWithTokenUrl"}],"discriminator":{"propertyName":"type","mapping":{"AuthClientCredentialsWithTokenUrl":"#/components/schemas/AuthClientCredentialsWithTokenUrl"}}},"ConnectionSapDatasphereCatalog":{"type":"object","title":"SAP Datasphere Catalog Connection","description":"SAP Datasphere Catalog connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionSapDatasphereCatalog$","description":"Discriminator for SAP Datasphere Catalog connection"},"url":{"description":"SAP Datasphere Catalog URL","$ref":"#/components/schemas/ParameterString"},"datasphereCatalogAuth":{"description":"OAuth client credentials for ingesting the SAP Datasphere Catalog.","$ref":"#/components/schemas/AuthSapDatasphereCatalog"},"dataProductsAuth":{"description":"Optional OAuth client credentials for ingesting SAP Data Products. When omitted, SAP Data Products are not ingested.","$ref":"#/components/schemas/AuthClientCredentials"}},"required":["type","url","datasphereCatalogAuth"]},"AuthSapDatasphereCatalog":{"title":"SAP Datasphere Catalog Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthClientCredentialsWithTokenUrl"}],"discriminator":{"propertyName":"type","mapping":{"AuthClientCredentialsWithTokenUrl":"#/components/schemas/AuthClientCredentialsWithTokenUrl"}}},"ConnectionSigma":{"type":"object","title":"Sigma Connection","description":"Sigma connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionSigma$","description":"Discriminator for Sigma connection"},"url":{"description":"Sigma instance base URL, e.g. https://aws-api.sigmacomputing.com","$ref":"#/components/schemas/ParameterString"},"tenantUrl":{"description":"Tenant-specific URL, e.g. https://app.sigmacomputing.com/your-tenant","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthSigma"}},"required":["type","url","tenantUrl","auth"]},"AuthSigma":{"title":"Sigma Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthClientCredentials"}],"discriminator":{"propertyName":"type","mapping":{"AuthClientCredentials":"#/components/schemas/AuthClientCredentials"}}},"ConnectionSnowflake":{"type":"object","title":"Snowflake Connection","description":"Snowflake connection.","properties":{"type":{"type":"string","pattern":"^ConnectionSnowflake$","description":"Discriminator for Snowflake connection."},"account":{"description":"The Account Identifier for the Snowflake account. This often includes cloud region information (e.g., xy123456.eu-central-1).","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthSnowflake"},"role":{"description":"The role to use in the Snowflake session.","$ref":"#/components/schemas/ParameterString"},"warehouse":{"description":"The name of the Snowflake warehouse. Defaults to the user's default warehouse if not specified.","$ref":"#/components/schemas/ParameterString"}},"required":["type","account","auth"]},"AuthSnowflake":{"title":"Snowflake Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthSnowflakeKeyPair"},{"$ref":"#/components/schemas/AuthSnowflakePat"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthSnowflakeKeyPair":"#/components/schemas/AuthSnowflakeKeyPair","AuthSnowflakePat":"#/components/schemas/AuthSnowflakePat"}}},"AuthSnowflakeKeyPair":{"title":"Snowflake Key Pair Authentication","type":"object","description":"Key pair authentication for Snowflake.","properties":{"type":{"type":"string","pattern":"^AuthSnowflakeKeyPair$"},"username":{"description":"The username to authenticate against the Snowflake account.","$ref":"#/components/schemas/ParameterString"},"privateKeyEdgeArtifact":{"description":"The private key artifact in P8 format for key pair authentication.","$ref":"#/components/schemas/ParameterSecretEdgeArtifact"},"privateKeyPwd":{"description":"The passphrase for the private key, if it is encrypted.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","username","privateKeyEdgeArtifact"]},"ParameterSecretEdgeArtifact":{"description":"References a sensitive artifact stored on the Edge site. The file content never leaves the Edge site cluster. Use for private keys and other sensitive artifacts.\n","type":"object","oneOf":[{"$ref":"#/components/schemas/ValueSecretEdgeArtifactId"},{"$ref":"#/components/schemas/ValueVaultArtifact"}],"discriminator":{"propertyName":"type","mapping":{"ValueSecretEdgeArtifactId":"#/components/schemas/ValueSecretEdgeArtifactId","ValueVaultArtifact":"#/components/schemas/ValueVaultArtifact"}}},"AuthSnowflakePat":{"title":"Snowflake Programmatic Access Token Authentication","type":"object","description":"Programmatic Access Token (PAT) authentication for Snowflake.","properties":{"type":{"type":"string","pattern":"^AuthSnowflakePat$"},"programmaticAccessToken":{"description":"Programmatic Access Token generated in Snowflake.","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","programmaticAccessToken"]},"ConnectionSsrs":{"type":"object","title":"Microsoft SSRS/PBRS Connection","description":"Microsoft SSRS/PBRS connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionSsrs$","description":"Discriminator for Microsoft SSRS/PBRS Connection"},"url":{"description":"Microsoft SSRS/PBRS URL","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthSsrs"}},"required":["type","url","auth"]},"AuthSsrs":{"title":"SSRS Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic"}}},"ConnectionTableau":{"type":"object","title":"Tableau Connection","description":"Tableau connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionTableau$","description":"Discriminator for Tableau Connection"},"url":{"description":"URL of the Tableau Server or Tableau Cloud site.","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthTableau"},"certFile":{"description":"Custom certificate","$ref":"#/components/schemas/ParameterEdgeArtifact"}},"required":["type","url","auth"]},"AuthTableau":{"title":"Tableau Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"},{"$ref":"#/components/schemas/AuthTableauToken"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic","AuthTableauToken":"#/components/schemas/AuthTableauToken"}}},"AuthTableauToken":{"title":"Tableau Token Authentication","type":"object","properties":{"type":{"type":"string","pattern":"^AuthTableauToken$"},"tokenName":{"description":"Name of the service/account token (any unique meaningful name can be used)","$ref":"#/components/schemas/ParameterString"},"tokenSecret":{"description":"Value of the service/account token","$ref":"#/components/schemas/ParameterSecretString"}},"required":["type","tokenName","tokenSecret"]},"ConnectionThoughtSpot":{"type":"object","title":"ThoughtSpot Connection","description":"ThoughtSpot connection\n","properties":{"type":{"type":"string","pattern":"^ConnectionThoughtSpot$","description":"Discriminator for ThoughtSpot connection"},"url":{"description":"ThoughtSpot instance base URL, e.g. https://customer.thoughtspot.cloud","$ref":"#/components/schemas/ParameterString"},"auth":{"$ref":"#/components/schemas/AuthThoughtSpot"}},"required":["type","url","auth"]},"AuthThoughtSpot":{"title":"ThoughtSpot Authentication","type":"object","oneOf":[{"$ref":"#/components/schemas/AuthBasic"}],"discriminator":{"propertyName":"type","mapping":{"AuthBasic":"#/components/schemas/AuthBasic"}}}}}} ``` ## The Site object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"Site":{"type":"object","description":"An Edge site.","required":["id","name","type","status","createdOn"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the Edge site."},"name":{"type":"string","description":"Human-readable name of the Edge site.","maxLength":100},"description":{"type":"string","description":"Optional description of the Edge site.","maxLength":255},"createdOn":{"type":"string","format":"date-time","description":"Timestamp when the Edge site was created."},"type":{"type":"string","description":"Deployment type of the Edge site.\nPossible values are:\n* `ON_PREM`\n* `COLLIBRA_HOSTED`\n* `AIR_GAPPED`\n* `FEDRAMP`\n"},"status":{"type":"string","description":"Current status of the Edge site. Values are reported in this precedence order\n(top-of-list wins):\n* `PENDING` — installed but has never contacted the platform\n* `OFFLINE` — no recent heartbeat (overrides `UPGRADING`/`HEALTHY`/`UNHEALTHY`)\n* `UPGRADING` — an upgrade to `pendingVersion` is in progress (overrides `HEALTHY`/`UNHEALTHY`)\n* `HEALTHY`\n* `UNHEALTHY`\n\nNote: `pendingVersion` may be set even when `status` is `OFFLINE` or `PENDING` — it\nreflects the desired version regardless of whether the upgrade is currently active.\n"},"currentVersion":{"type":"string","maxLength":100,"description":"Currently installed Edge version. Absent if the site has not reported a version yet."},"pendingVersion":{"type":"string","maxLength":100,"description":"Edge version the site should be upgrading or installing to. Absent when the site is already at its desired version.\n"}}}}}} ``` ## The SiteDetail object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"SiteDetail":{"description":"Detailed representation of an Edge site. Extends the `Site` summary returned by the list endpoint; fields that are too detailed for the list response are added here.\n","allOf":[{"$ref":"#/components/schemas/Site"},{"type":"object","required":["sparkEnabled","upgradeMode","autoUpgradeEnabled"],"properties":{"sparkEnabled":{"type":"boolean","description":"Whether Spark-based processing is enabled on the Edge site."},"autoUpgradeEnabled":{"type":"boolean","description":"Whether the Edge site is configured to be automatically upgraded to the latest available version as new versions are released. Reflects the `autoUpgradeEnabled` value from the create/update request. Note that `upgradeMode` values `EXTERNAL` and `LEGACY` take precedence over this setting - a site whose upgrades are managed externally is never auto-upgraded by Collibra regardless of this value.\n"},"upgradeMode":{"type":"string","description":"How Edge version upgrades are applied to the site.\nPossible values are:\n* `AUTOMATIC` — the site is upgraded automatically when a new Edge version is released\n* `MANUAL` — upgrades must be triggered explicitly\n* `EXTERNAL` — upgrades are managed outside of Collibra. Reported for air-gapped installations and for sites explicitly marked as externally managed.\n* `LEGACY` — the site predates managed upgrades and has not reported a version yet\n\n`AUTOMATIC` and `MANUAL` reflect the site's `autoUpgradeEnabled` setting;\n`EXTERNAL` and `LEGACY` take precedence over it.\n"},"lastModifiedOn":{"type":"string","format":"date-time","description":"Timestamp when the site was last modified. Modification events include configuration changes, restores, upgrade-mode changes, and Edge version changes (requested or completed). Site creation itself counts as a modification, so newly-created sites have `lastModifiedOn` equal to `createdOn`. The field is absent only for legacy sites that predate the site event log and have no recorded history.\n"}}}]},"Site":{"type":"object","description":"An Edge site.","required":["id","name","type","status","createdOn"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the Edge site."},"name":{"type":"string","description":"Human-readable name of the Edge site.","maxLength":100},"description":{"type":"string","description":"Optional description of the Edge site.","maxLength":255},"createdOn":{"type":"string","format":"date-time","description":"Timestamp when the Edge site was created."},"type":{"type":"string","description":"Deployment type of the Edge site.\nPossible values are:\n* `ON_PREM`\n* `COLLIBRA_HOSTED`\n* `AIR_GAPPED`\n* `FEDRAMP`\n"},"status":{"type":"string","description":"Current status of the Edge site. Values are reported in this precedence order\n(top-of-list wins):\n* `PENDING` — installed but has never contacted the platform\n* `OFFLINE` — no recent heartbeat (overrides `UPGRADING`/`HEALTHY`/`UNHEALTHY`)\n* `UPGRADING` — an upgrade to `pendingVersion` is in progress (overrides `HEALTHY`/`UNHEALTHY`)\n* `HEALTHY`\n* `UNHEALTHY`\n\nNote: `pendingVersion` may be set even when `status` is `OFFLINE` or `PENDING` — it\nreflects the desired version regardless of whether the upgrade is currently active.\n"},"currentVersion":{"type":"string","maxLength":100,"description":"Currently installed Edge version. Absent if the site has not reported a version yet."},"pendingVersion":{"type":"string","maxLength":100,"description":"Edge version the site should be upgrading or installing to. Absent when the site is already at its desired version.\n"}}}}}} ``` ## The SiteCreate object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"SiteCreate":{"type":"object","description":"An Edge site create DTO.","required":["name","type"],"properties":{"name":{"type":"string","description":"Human-readable name of the Edge site. Site names are unique - creating a site with a name that is already in use returns a 409 with error code `siteNameAlreadyExists`.\n","minLength":1,"maxLength":100,"pattern":"^[a-zA-Z0-9_.-]+$"},"description":{"type":"string","description":"Optional description of the Edge site. If provided, must not be empty - omit the field entirely when no description is wanted.\n","maxLength":255,"pattern":".*\\S.*"},"version":{"type":"string","description":"Optional Edge chart version to install, in the Edge release version format `..[-]`, e.g. `2026.06.1-3` (the same format reported by `Site.currentVersion` and `Site.pendingVersion`). If omitted, the site is created with the latest available version. Required for `AIR_GAPPED` sites.\n","maxLength":100,"pattern":"^(2[0-9]{3})\\.(0?[1-9]|1[0-2])(\\.\\d+)(-.*)?$"},"type":{"type":"string","description":"Deployment type of the Edge site. Only `ON_PREM` and `AIR_GAPPED` sites can be\ncreated via this endpoint; any other value (e.g. `COLLIBRA_HOSTED`, `FEDRAMP`) is\nrejected with a 400 — Collibra Cloud sites are provisioned by Collibra.\nPossible values are:\n* `ON_PREM`\n* `AIR_GAPPED`\n"},"autoUpgradeEnabled":{"type":"boolean","default":true,"description":"Whether the Edge site should be automatically upgraded to the latest available version as new versions are released. Defaults to `true` for `ON_PREM` sites - set to `false` to opt out of automatic upgrades and manage the site's version manually. For `AIR_GAPPED` sites this must be set explicitly to `false` (the `true` default does not apply); omitting it or setting `true` is rejected with a 400. The stored value is reported back as `SiteDetail.autoUpgradeEnabled` and drives `SiteDetail.upgradeMode` (`AUTOMATIC`/`MANUAL`).\n"}}}}}} ``` ## The SiteUpdate object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"SiteUpdate":{"type":"object","description":"An Edge site update DTO.","required":["name","description","version","autoUpgradeEnabled","sparkEnabled"],"properties":{"name":{"type":"string","description":"Human-readable name of the Edge site. Must contain at least one non-whitespace character; empty or whitespace-only names are rejected with a 400.\n","minLength":1,"maxLength":100,"pattern":"^[a-zA-Z0-9_.-]+$"},"description":{"type":["string","null"],"description":"Description of the Edge site. If a string is provided, it must not be empty - use `null` to clear the description.\n","minLength":1,"maxLength":255},"version":{"type":"string","description":"Edge chart version to target, in the Edge release version format `..[-]`, e.g. `2026.06.1-3` (the same format reported by `Site.currentVersion` and `Site.pendingVersion`).\n","maxLength":100,"pattern":"^(2[0-9]{3})\\.(0?[1-9]|1[0-2])(\\.\\d+)(-.*)?$"},"autoUpgradeEnabled":{"type":"boolean","description":"Whether the Edge site should be auto-upgraded to the latest available version."},"sparkEnabled":{"type":"boolean","description":"Whether the Edge site should enable Spark."}}}}}} ``` ## The SiteListResponse object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"SiteListResponse":{"type":"object","description":"List of Edge sites. The number of sites per environment is expected to remain small, so the full list is always returned in a single response. Pagination is intentionally omitted.\n","required":["results"],"properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/Site"}}}},"Site":{"type":"object","description":"An Edge site.","required":["id","name","type","status","createdOn"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the Edge site."},"name":{"type":"string","description":"Human-readable name of the Edge site.","maxLength":100},"description":{"type":"string","description":"Optional description of the Edge site.","maxLength":255},"createdOn":{"type":"string","format":"date-time","description":"Timestamp when the Edge site was created."},"type":{"type":"string","description":"Deployment type of the Edge site.\nPossible values are:\n* `ON_PREM`\n* `COLLIBRA_HOSTED`\n* `AIR_GAPPED`\n* `FEDRAMP`\n"},"status":{"type":"string","description":"Current status of the Edge site. Values are reported in this precedence order\n(top-of-list wins):\n* `PENDING` — installed but has never contacted the platform\n* `OFFLINE` — no recent heartbeat (overrides `UPGRADING`/`HEALTHY`/`UNHEALTHY`)\n* `UPGRADING` — an upgrade to `pendingVersion` is in progress (overrides `HEALTHY`/`UNHEALTHY`)\n* `HEALTHY`\n* `UNHEALTHY`\n\nNote: `pendingVersion` may be set even when `status` is `OFFLINE` or `PENDING` — it\nreflects the desired version regardless of whether the upgrade is currently active.\n"},"currentVersion":{"type":"string","maxLength":100,"description":"Currently installed Edge version. Absent if the site has not reported a version yet."},"pendingVersion":{"type":"string","maxLength":100,"description":"Edge version the site should be upgrading or installing to. Absent when the site is already at its desired version.\n"}}}}}} ``` ## The SiteVersionsListResponse object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"SiteVersionsListResponse":{"type":"object","description":"List of versions, available to upgrade Edge site to.\n","required":["results"],"properties":{"results":{"type":"array","items":{"type":"string"}}}}}}} ``` ## The VaultListResponse object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"VaultListResponse":{"type":"object","description":"List of vaults for a site. The number of vaults per site is expected to remain small and is typically less than 3, so the full list is always returned in a single response. Pagination is intentionally omitted.\n","required":["results"],"properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/Vault"}}}},"Vault":{"type":"object","required":["id","type","name"],"properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","maxLength":4000}},"description":"Vault response body."}}}} ``` ## The Vault object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"Vault":{"type":"object","required":["id","type","name"],"properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","maxLength":4000}},"description":"Vault response body."}}}} ``` ## The ConnectionTestResponse object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"ConnectionTestResponse":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean"},"message":{"type":"string","description":"Additional information about the test result."}},"description":"Test connection response body."}}}} ``` ## The DriverJarListResponse object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"DriverJarListResponse":{"type":"object","required":["results"],"properties":{"nextCursor":{"type":"string","description":"Cursor for the next page of results. Absent if there are no more results."},"results":{"type":"array","items":{"$ref":"#/components/schemas/DriverJar"}}},"description":"List of driver jar files available for an Edge site."},"DriverJar":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Reference id for the driver jar."},"name":{"type":"string","description":"Name of the JDBC driver (e.g., \"postgres-16\", \"mysql-8\").","maxLength":128},"version":{"type":"string","description":"Semantic version of the JDBC driver (e.g., \"42.2.20\", \"8.0.23\").","maxLength":100,"pattern":"^\\d+\\.\\d+\\.\\d+(-[a-zA-Z0-9.-]+)?(\\+[a-zA-Z0-9.-]+)?$"},"filename":{"type":"string","description":"Original filename of the uploaded jar (e.g. \"postgresql-42.7.3.jar\")."},"createdOn":{"type":"string","format":"date-time","description":"Timestamp when the driver jar was uploaded."},"lastModifiedOn":{"type":"string","format":"date-time","description":"Timestamp when the driver jar was last updated."},"checksum":{"type":"string","description":"SHA-256 digest of the file content, encoded as URL-safe Base64 without padding."},"signature":{"description":"Associated signature file for verification. Omitted when the jar has no signature.","$ref":"#/components/schemas/DriverSignatureResponse"}},"required":["id","name","version","filename","checksum"]},"DriverSignatureResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"UUID of the signature record."},"filename":{"type":"string","description":"Original filename of the uploaded signature file."},"signatureContent":{"type":"string","contentEncoding":"base64","maxLength":13656,"description":"Signature file content encoded as standard Base64. The original signature file is at most 10 KB.\n"},"createdOn":{"type":"string","format":"date-time","description":"Timestamp when the signature was first uploaded."},"lastModifiedOn":{"type":"string","format":"date-time","description":"Timestamp when the signature was last replaced."}},"required":["id","filename","signatureContent","createdOn","lastModifiedOn"]}}}} ``` ## The DriverJar object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"DriverJar":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Reference id for the driver jar."},"name":{"type":"string","description":"Name of the JDBC driver (e.g., \"postgres-16\", \"mysql-8\").","maxLength":128},"version":{"type":"string","description":"Semantic version of the JDBC driver (e.g., \"42.2.20\", \"8.0.23\").","maxLength":100,"pattern":"^\\d+\\.\\d+\\.\\d+(-[a-zA-Z0-9.-]+)?(\\+[a-zA-Z0-9.-]+)?$"},"filename":{"type":"string","description":"Original filename of the uploaded jar (e.g. \"postgresql-42.7.3.jar\")."},"createdOn":{"type":"string","format":"date-time","description":"Timestamp when the driver jar was uploaded."},"lastModifiedOn":{"type":"string","format":"date-time","description":"Timestamp when the driver jar was last updated."},"checksum":{"type":"string","description":"SHA-256 digest of the file content, encoded as URL-safe Base64 without padding."},"signature":{"description":"Associated signature file for verification. Omitted when the jar has no signature.","$ref":"#/components/schemas/DriverSignatureResponse"}},"required":["id","name","version","filename","checksum"]},"DriverSignatureResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"UUID of the signature record."},"filename":{"type":"string","description":"Original filename of the uploaded signature file."},"signatureContent":{"type":"string","contentEncoding":"base64","maxLength":13656,"description":"Signature file content encoded as standard Base64. The original signature file is at most 10 KB.\n"},"createdOn":{"type":"string","format":"date-time","description":"Timestamp when the signature was first uploaded."},"lastModifiedOn":{"type":"string","format":"date-time","description":"Timestamp when the signature was last replaced."}},"required":["id","filename","signatureContent","createdOn","lastModifiedOn"]}}}} ``` ## The DriverSignatureResponse object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"DriverSignatureResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"UUID of the signature record."},"filename":{"type":"string","description":"Original filename of the uploaded signature file."},"signatureContent":{"type":"string","contentEncoding":"base64","maxLength":13656,"description":"Signature file content encoded as standard Base64. The original signature file is at most 10 KB.\n"},"createdOn":{"type":"string","format":"date-time","description":"Timestamp when the signature was first uploaded."},"lastModifiedOn":{"type":"string","format":"date-time","description":"Timestamp when the signature was last replaced."}},"required":["id","filename","signatureContent","createdOn","lastModifiedOn"]}}}} ``` ## The NativeLibListResponse object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"NativeLibListResponse":{"type":"object","required":["results"],"properties":{"nextCursor":{"type":"string","description":"Cursor for the next page of results. Absent if there are no more results."},"results":{"type":"array","items":{"$ref":"#/components/schemas/NativeLib"}}},"description":"Response body containing a list of NativeLib items."},"NativeLib":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Reference id for the native library."},"name":{"type":"string","description":"Name of the native library.","maxLength":128},"version":{"type":"string","description":"Semantic version of the native library.","maxLength":100,"pattern":"^\\d+\\.\\d+\\.\\d+(-[a-zA-Z0-9.-]+)?(\\+[a-zA-Z0-9.-]+)?$"},"filename":{"type":"string","description":"Original filename of the uploaded native library (e.g. \"libsapjco3.so\")"},"createdOn":{"type":"string","format":"date-time","description":"Timestamp when the native library was uploaded."},"lastModifiedOn":{"type":"string","format":"date-time","description":"Timestamp when the native library was last updated."},"checksum":{"type":"string","description":"SHA-256 digest of the file content, encoded as URL-safe Base64 without padding."},"signature":{"description":"Associated signature file for verification. Omitted when the native library has no signature.","$ref":"#/components/schemas/DriverSignatureResponse"}},"required":["id","name","version","filename","checksum"],"description":"Native library object available for an Edge site."},"DriverSignatureResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"UUID of the signature record."},"filename":{"type":"string","description":"Original filename of the uploaded signature file."},"signatureContent":{"type":"string","contentEncoding":"base64","maxLength":13656,"description":"Signature file content encoded as standard Base64. The original signature file is at most 10 KB.\n"},"createdOn":{"type":"string","format":"date-time","description":"Timestamp when the signature was first uploaded."},"lastModifiedOn":{"type":"string","format":"date-time","description":"Timestamp when the signature was last replaced."}},"required":["id","filename","signatureContent","createdOn","lastModifiedOn"]}}}} ``` ## The NativeLib object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"NativeLib":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Reference id for the native library."},"name":{"type":"string","description":"Name of the native library.","maxLength":128},"version":{"type":"string","description":"Semantic version of the native library.","maxLength":100,"pattern":"^\\d+\\.\\d+\\.\\d+(-[a-zA-Z0-9.-]+)?(\\+[a-zA-Z0-9.-]+)?$"},"filename":{"type":"string","description":"Original filename of the uploaded native library (e.g. \"libsapjco3.so\")"},"createdOn":{"type":"string","format":"date-time","description":"Timestamp when the native library was uploaded."},"lastModifiedOn":{"type":"string","format":"date-time","description":"Timestamp when the native library was last updated."},"checksum":{"type":"string","description":"SHA-256 digest of the file content, encoded as URL-safe Base64 without padding."},"signature":{"description":"Associated signature file for verification. Omitted when the native library has no signature.","$ref":"#/components/schemas/DriverSignatureResponse"}},"required":["id","name","version","filename","checksum"],"description":"Native library object available for an Edge site."},"DriverSignatureResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"UUID of the signature record."},"filename":{"type":"string","description":"Original filename of the uploaded signature file."},"signatureContent":{"type":"string","contentEncoding":"base64","maxLength":13656,"description":"Signature file content encoded as standard Base64. The original signature file is at most 10 KB.\n"},"createdOn":{"type":"string","format":"date-time","description":"Timestamp when the signature was first uploaded."},"lastModifiedOn":{"type":"string","format":"date-time","description":"Timestamp when the signature was last replaced."}},"required":["id","filename","signatureContent","createdOn","lastModifiedOn"]}}}} ``` ## The EdgeArtifact object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"EdgeArtifact":{"title":"Edge Artifact","description":"Specifies the artifact file to upload for use as a data source connection property.","type":"object","required":["id","name","filename","createdOn","lastModifiedOn","checksum"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the Edge artifact."},"name":{"type":"string","description":"Name of the uploaded file.","maxLength":128},"filename":{"type":"string","description":"Original filename of the uploaded file."},"createdOn":{"type":"string","format":"date-time","description":"Timestamp when the artifact was created."},"lastModifiedOn":{"type":"string","format":"date-time","description":"Timestamp when the artifact was last updated."},"checksum":{"type":"string","description":"SHA-256 digest of the file content, encoded as URL-safe Base64 without padding."}}}}}} ``` ## The EdgeArtifactListResponse object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"EdgeArtifactListResponse":{"type":"object","required":["results"],"properties":{"nextCursor":{"type":"string","description":"Cursor for the next page of results. Absent if there are no more results."},"results":{"type":"array","items":{"$ref":"#/components/schemas/EdgeArtifact"}}},"description":"Paginated list of edge artifacts."},"EdgeArtifact":{"title":"Edge Artifact","description":"Specifies the artifact file to upload for use as a data source connection property.","type":"object","required":["id","name","filename","createdOn","lastModifiedOn","checksum"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the Edge artifact."},"name":{"type":"string","description":"Name of the uploaded file.","maxLength":128},"filename":{"type":"string","description":"Original filename of the uploaded file."},"createdOn":{"type":"string","format":"date-time","description":"Timestamp when the artifact was created."},"lastModifiedOn":{"type":"string","format":"date-time","description":"Timestamp when the artifact was last updated."},"checksum":{"type":"string","description":"SHA-256 digest of the file content, encoded as URL-safe Base64 without padding."}}}}}} ``` ## The EdgeSecretArtifact object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"EdgeSecretArtifact":{"title":"Edge Secret Artifact","description":"Secret artifact file stored directly on the Edge site. File content never leaves the site.","type":"object","required":["id"],"properties":{"id":{"type":"string","maxLength":512,"description":"Base64url-encoded identifier for the secret artifact. Use this value directly in `secretEdgeArtifactId` connection parameters to reference the secret.\n"}}}}}} ``` ## The ErrorResponse object ```json {"openapi":"3.1.0","info":{"title":"Collibra Edge API","version":"1.0.1"},"components":{"schemas":{"ErrorResponse":{"type":"object","description":"Standard error response returned by the API when an operation fails.","required":["statusCode","errorCode"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code."},"titleMessage":{"type":"string","description":"Short title describing the error category."},"helpMessage":{"type":"string","description":"Additional guidance for resolving the error."},"userMessage":{"type":"string","description":"Human-readable message describing what went wrong."},"errorCode":{"type":"string","description":"Machine-readable error code for programmatic handling."}}}}}} ```