Skip to main content
PATCH
Update Target Credential

Authorizations

Authorization
string
header
required

API key generated from the MindFort dashboard. Pass as Authorization: Bearer <your-api-key>.

Path Parameters

target_id
string<uuid>
required
credential_id
string<uuid>
required

Body

application/json
credential_name
string
Required string length: 1 - 255
credential_type
enum<string>
Available options:
application_login,
magic_link,
email_mfa,
authenticator_2fa,
sms_mfa,
sms_login,
api_key
username
string
Maximum string length: 255
password
string
write-only
Required string length: 1 - 255
role
enum<string>
Available options:
user,
admin,
viewer,
editor,
custom
description
string | null
login_instructions
string | null
pending_email_id
string<uuid>
authenticator_2fa_secret
string
write-only
Required string length: 1 - 255
api_key_credential
object
write-only

Response

200 - application/json

Credential updated

id
string<uuid>
required
role
string
required
api_key_configured
boolean
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
credential_name
string | null
username
string | null
description
string | null
login_instructions
string | null
credential_type
string | null
agentmail_email
string | null
authenticator_phone_number
string | null

System-provisioned phone number for SMS credentials; not a writable authenticator input.

api_key_placement
object | null
api_additional_fields
object | null