Type Alias DataCredentialsAPI

type DataCredentialsAPI = {
    clearCache: typeof dataCredentials.clearCache;
    deleteDataCredential: typeof dataCredentials.deleteDataCredential;
    filterOrphanDataCredentials: typeof filterOrphanDataCredentials;
    getDataCredential: typeof dataCredentials.getDataCredential;
    patchDataCredential: typeof dataCredentials.patchDataCredential;
    updateDataCredential: typeof dataCredentials.updateDataCredential;
}
Index

Properties

clearCache deleteDataCredential filterOrphanDataCredentials getDataCredential patchDataCredential updateDataCredential

Properties

clearCache: typeof dataCredentials.clearCache

Clears the cache for data-credentials api requests.

deleteDataCredential: typeof dataCredentials.deleteDataCredential

Use this operation to delete a data credential by its unique identifier. To delete a credential by name instead of ID, set the byCredentialName query parameter to true.

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

The unique identifier of the credential.

an object with query parameters

DeleteDataCredentialHttpError

filterOrphanDataCredentials: typeof filterOrphanDataCredentials

Use this operation to retrieve data credentials that are not associated with any data connection. Filter results by credential type, data source ID, or separation status using the request body.

Param: body

an object with the body content

FilterOrphanDataCredentialsHttpError

getDataCredential: typeof dataCredentials.getDataCredential

Use this operation to retrieve a single data credential by its unique identifier. To look up a credential by name instead of ID, set the byCredentialName query parameter to true.

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

The unique identifier of the credential.

an object with query parameters

GetDataCredentialHttpError

patchDataCredential: typeof dataCredentials.patchDataCredential

Use this operation to apply partial updates to a data credential using JSON Patch operations. To patch a credential by name instead of ID, set the byCredentialName query parameter to true.

The unique identifier of the credential.

an object with query parameters

Param: body

an object with the body content

PatchDataCredentialHttpError

updateDataCredential: typeof dataCredentials.updateDataCredential

Use this operation to replace an existing data credential with the values provided in the request body. To update a credential by name instead of ID, set the byCredentialName query parameter to true.

The unique identifier of the credential.

an object with query parameters

Param: body

an object with the body content

UpdateDataCredentialHttpError

Settings

Member Visibility

On This Page

Properties