Sign in
latestOpenAPI 3.0.32026-08-227451,2751.8 MB

d0fc0114da66

Credentials

Update Credentials

Update existing credentials. NOTE: TOTP tokens will be unchanged if NULL passed. They will be cleared if '' (blank string) is passed.

patch/credentials/{id}

Path parameters

idstring required

ID of credentials to update

Headers

If-Matchstring

If-Match header according to http/1.1 spec section 14.24

Request body

idstring

ID of credentials

created_timeinteger

Time credentials were created

created_by_idstring

User ID who created these credentials

last_updated_timeinteger

Time credentials entity was last updated

last_updated_by_idstring

User ID who last updated these credentials

organization_idstring

Organization ID

namestring

Display name

descriptionstring

Description

cloud_onlyboolean

True if the credentials secrets are only accessible to cloud runs. Cannot be changed from true to false.

type'basic' | 'basic_with_totp'

Type of credentials

propertiesobject

Properties that are specific to the given credentials type.

Response

Updated credentials

idstring

ID of credentials

created_timeinteger

Time credentials were created

created_by_idstring

User ID who created these credentials

last_updated_timeinteger

Time credentials entity was last updated

last_updated_by_idstring

User ID who last updated these credentials

organization_idstring

Organization ID

namestring

Display name

descriptionstring

Description

cloud_onlyboolean

True if the credentials secrets are only accessible to cloud runs. Cannot be changed from true to false.

type'basic' | 'basic_with_totp'

Type of credentials

propertiesobject

Properties that are specific to the given credentials type.