Credentials

Create Target Credential

Store a credential on a target. Email MFA requires pending_email_id; username and password are optional and should be supplied only when the target requests primary credentials. Before adding an api_key credential, the API target must already have non-empty api_auth_instructions; update the target with the validation route, HTTP method, request shape, and successful response first.

post/v1/targets/{target_id}/credentials

Request

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

Path parameters

target_idstring uuid required

Request body

credential_namestring required

usernamestring nullable

Username for login credential types. Optional for email_mfa.

passwordstring nullable

Password for login credential types. Optional for email_mfa.

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 nullable

authenticator_2fa_secretstring nullable

sms_country_codestring nullable

Response

Credential stored

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.