Type Alias DataCredentialsAPI

type DataCredentialsAPI = {
    clearCache: typeof clearCache;
    deleteDataCredential: typeof deleteDataCredential;
    filterOrphanedDataCredentials: typeof filterOrphanedDataCredentials;
    getDataCredential: typeof getDataCredential;
    patchDataCredential: typeof patchDataCredential;
    updateDataCredential: typeof updateDataCredential;
}
Index

Properties

clearCache deleteDataCredential filterOrphanedDataCredentials getDataCredential patchDataCredential updateDataCredential

Properties

clearCache: typeof clearCache

Clears the cache for data-credentials api requests.

deleteDataCredential: typeof deleteDataCredential

Deletes the specified credential by ID (or by name when type=credentialname is set in query)

deleteDataCredential(
  "027d2703-e745-43ec-8876-a2e6ac341700",
  {
    byCredentialName: false
  }
)

Credential ID

an object with query parameters

DeleteDataCredentialHttpError

filterOrphanedDataCredentials: typeof filterOrphanedDataCredentials

Gets list of orphan data credentials (i.e. credentials that are not associated to any data connection) filtering on properties defined in request body

Param: body

an object with the body content

FilterOrphanedDataCredentialsHttpError

getDataCredential: typeof getDataCredential

Gets a credential by ID (or by name when bycredentialname=true is set in query)

getDataCredential(
  "027d2703-e745-43ec-8876-a2e6ac341700",
  {
    byCredentialName: false
  }
)

Credential ID

an object with query parameters

GetDataCredentialHttpError

patchDataCredential: typeof patchDataCredential

Patches a credential specified by ID (or by name when bycredentialname=true is set in query)

Credential ID

an object with query parameters

Param: body

an object with the body content

PatchDataCredentialHttpError

updateDataCredential: typeof updateDataCredential

Updates a credential specified by ID (or by name when bycredentialname=true is set in query)

Credential ID

an object with query parameters

Param: body

an object with the body content

UpdateDataCredentialHttpError

Settings

Member Visibility

On This Page

Properties