Boomi MFT - AFT Management API Reference (v1) - AdminMfaSettings

Toggle Pane

• AdminMfaSettings
  • getRetrieves customer multi-factor authentication (MFA) settings
  • postCreates new customer multi-factor authentication (MFA) settings
  • putUpdates existing customer multi-factor authentication (MFA) settings
  • putSaves customer multi-factor authentication (MFA) settings (creates new or updates existing based on ID)

API docs by Redocly

Download OpenAPI Specification: Download

For more information about Postman collections, forking, and making your first API call, refer to the Working with Boomi APIs on Postman page.

AdminMfaSettings

Retrieves customer multi-factor authentication (MFA) settings

Returns multi-factor authentication configuration including enabled status and trusted device TTL settings.

Authorizations:

ApiKeyBearer

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
customerId	integer <int32>
isEnabled	boolean
trustedDeviceTTLMinutes	integer <int64>
createdBy	string or null
createdDate	string <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>

https://us.thruinc.com/api/AdminMfaSettings

https://uk.thruinc.com/api/AdminMfaSettings

https://eu.thruinc.com/api/AdminMfaSettings

https://au.thruinc.com/api/AdminMfaSettings

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Creates new customer multi-factor authentication (MFA) settings

Establishes new MFA configuration with specified authentication requirements and device trust settings.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Customer MFA configuration details

id	integer <int32>
customerId	integer <int32>
isEnabled	boolean
trustedDeviceTTLMinutes	integer <int64>
createdBy	string or null
createdDate	string <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (CustomerMfaSettings)
recordsAffected	integer <int32>

https://us.thruinc.com/api/AdminMfaSettings

https://uk.thruinc.com/api/AdminMfaSettings

https://eu.thruinc.com/api/AdminMfaSettings

https://au.thruinc.com/api/AdminMfaSettings

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "customerId": 0,
• "isEnabled": true,
• "trustedDeviceTTLMinutes": 0,
• "createdBy": "string",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updatedDate": "2019-08-24T14:15:22Z",
• "deletedBy": "string",
• "deletedDate": "2019-08-24T14:15:22Z"

}

Response samples

• 200
• 400
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Updates existing customer multi-factor authentication (MFA) settings

Modifies existing MFA configuration including authentication requirements and trusted device settings.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Updated customer MFA configuration

id	integer <int32>
customerId	integer <int32>
isEnabled	boolean
trustedDeviceTTLMinutes	integer <int64>
createdBy	string or null
createdDate	string <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (CustomerMfaSettings)
recordsAffected	integer <int32>

https://us.thruinc.com/api/AdminMfaSettings

https://uk.thruinc.com/api/AdminMfaSettings

https://eu.thruinc.com/api/AdminMfaSettings

https://au.thruinc.com/api/AdminMfaSettings

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "customerId": 0,
• "isEnabled": true,
• "trustedDeviceTTLMinutes": 0,
• "createdBy": "string",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updatedDate": "2019-08-24T14:15:22Z",
• "deletedBy": "string",
• "deletedDate": "2019-08-24T14:15:22Z"

}

Response samples

• 200
• 400
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Saves customer multi-factor authentication (MFA) settings (creates new or updates existing based on ID)

Performs upsert operation: creates new MFA settings if ID is 0, otherwise updates existing settings

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Customer MFA configuration to save

id	integer <int32>
customerId	integer <int32>
isEnabled	boolean
trustedDeviceTTLMinutes	integer <int64>
createdBy	string or null
createdDate	string <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (CustomerMfaSettings)
recordsAffected	integer <int32>

https://us.thruinc.com/api/AdminMfaSettings/save

https://uk.thruinc.com/api/AdminMfaSettings/save

https://eu.thruinc.com/api/AdminMfaSettings/save

https://au.thruinc.com/api/AdminMfaSettings/save

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "customerId": 0,
• "isEnabled": true,
• "trustedDeviceTTLMinutes": 0,
• "createdBy": "string",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updatedDate": "2019-08-24T14:15:22Z",
• "deletedBy": "string",
• "deletedDate": "2019-08-24T14:15:22Z"

}

Response samples

• 200
• 400
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample