Warehouse Credential

Update WarehouseCredential

Update WarehouseCredential.

patch/api/v3/warehouse-credential/{warehouse_credential_id}

Request

  • Base URL
    https://{tenant_name}.benchling.com
  • Auth
    HTTP bearer

Path parameters

warehouse_credential_idstring required

ID of the WarehouseCredential.

Request body

revokedboolean required

Indicates whether or not the WarehouseCredential has been revoked. When a WarehouseCredential is revoked, the credentials are deleted in the warehouse and can not be reactivated. The only valid value for this field is true.

Response

OK

__typenamestring
createdAtstring datetime nullable
expiresAtstring datetime nullable

The time after which new connections using the username/password will not be permitted. Upon expiration, currently open connections are not terminated.

idstring
labelstring nullable

An optional label defined by the user who created the WarehouseCredential.

modifiedAtstring datetime nullable
revokedboolean

Indicates whether or not the WarehouseCredential has been revoked. When a WarehouseCredential is revoked, the credentials are deleted in the warehouse and can not be reactivated.

usernamestring

The username to connect to the warehouse.

Changes

No recorded changes to this operation across all 1 revision of this API.