MImindfort
Credentials

Update Target Credential

Updates a stored target credential, such as its name, username, password, role, login instructions, 2FA secret, or API key settings.

patch/v1/targets/{target_id}/credentials/{credential_id}

Request

  • Base URL
    https://api.mindfort.app
  • URL
    https://api.mindfort.app/v1/targets/{target_id}/credentials/{credential_id}
  • Auth
    HTTP bearer

Path parameters

target_idstring uuid required
credential_idstring uuid required

Request body

credential_namestring
credential_type'application_login' | 'magic_link' | 'email_mfa' | 'authenticator_2fa' | 'sms_mfa' | 'sms_login' | 'api_key'
usernamestring
passwordstring
role'user' | 'admin' | 'viewer' | 'editor' | 'custom'
descriptionstring nullable
login_instructionsstring nullable
additional_auth_instructionsstring nullable

Instructions specific to this credential, used during authentication. Plain text only; HTML tags and unsupported control characters are rejected.

pending_email_idstring uuid
authenticator_2fa_secretstring

Response

Credential updated

idstring uuid required
credential_namestring nullable
usernamestring nullable
rolestring required
descriptionstring nullable
login_instructionsstring nullable
additional_auth_instructionsstring nullable

Instructions specific to this credential, used during authentication. Plain text only; HTML tags and unsupported control characters are rejected.

credential_typestring nullable
generated_emailstring nullable
authenticator_phone_numberstring nullable

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

api_key_configuredboolean required
api_additional_fieldsobject nullable
created_atstring date-time required
updated_atstring date-time required

Changes

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