DEdelta-incubator
CredentialsService

PATCH /credentials/{name}

Changed on

Request

Path parameters

namestring required

Name of credential.

Request body

namestring required

Name of credential.

newNamestring

Name of credential.

commentstring

Comment associated with the credential.

readOnlyboolean

Whether the credential is usable only for read operations. Only applicable when purpose is STORAGE.

ownerstring

Username of current owner of credential.

skipValidationboolean

Supply true to this argument to skip validation of the updated credential.

forceboolean

Force an update even if there are dependent services (when purpose is SERVICE) or dependent external locations and external tables (when purpose is STORAGE).

Response

OK

idstring

The unique identifier of the credential.

namestring

The credential name.

The name must be unique among storage and service credentials within the metastore.

purposeinteger

Indicates the purpose of the credential.

readOnlyboolean

Whether the credential is usable only for read operations.

Only applicable when purpose is STORAGE.

commentstring

User-provided free-form text description.

ownerstring

Username of current owner of credential.

createdAtstring

Time at which this credential was created, in epoch milliseconds.

createdBystring

Username of credential creator.

updatedAtstring

Time at which this credential was last updated, in epoch milliseconds.

updatedBystring

Username of user who last modified credential.

usedForManagedStorageboolean

Whether this credential is the current metastore's root storage credential.

Only applicable when purpose is STORAGE.

fullNamestring

The full name of the credential.

Changes