Saltar al contenido principal
POST
Create Target Credential

Autorizaciones

Authorization
string
header
requerido

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

Parámetros de ruta

target_id
string<uuid>
requerido

Cuerpo

application/json
credential_name
string
requerido
Required string length: 1 - 255
credential_type
enum<string>
requerido
Opciones disponibles:
application_login,
magic_link,
email_mfa,
authenticator_2fa,
sms_mfa,
sms_login,
api_key
username
string | null

Username for login credential types. Optional for email_mfa.

Maximum string length: 255
password
string | null
write-only

Password for login credential types. Optional for email_mfa.

Required string length: 1 - 255
role
enum<string>
predeterminado:user
Opciones disponibles:
user,
admin,
viewer,
editor,
custom
description
string | null
Maximum string length: 4000
login_instructions
string | null
Maximum string length: 10000
additional_auth_instructions
string | null

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

Maximum string length: 10000
pending_email_id
string<uuid> | null
authenticator_2fa_secret
string | null
write-only
Required string length: 1 - 255
api_key_credential
object | null
write-only
sms_country_code
string | null
Pattern: ^[A-Za-z]{2}$

Respuesta

201 - application/json

Credential stored

id
string<uuid>
requerido
role
string
requerido
api_key_configured
boolean
requerido
created_at
string<date-time>
requerido
updated_at
string<date-time>
requerido
credential_name
string | null
username
string | null
description
string | null
login_instructions
string | null
additional_auth_instructions
string | null

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

Maximum string length: 10000
credential_type
string | null
generated_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