Boomi MFT - AFT Management API Reference (v1) - Users
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.
Authenticates a user and returns access tokens
Supports MFA authentication for enhanced security. API Keys are the recommended method for programmatic access. For MFA setup, send initial request with username and password only to receive MFA challenge.
Authorizations:
ApiKeyBearer
Request Body schema:
Login credentials including username, password, and optional MFA code
| password required | string non-empty |
| userName required | string non-empty |
| oneTimePasscode | string or null |
Responses
Response Schema:
| accessToken | string or null |
| refreshToken | string or null |
Request samples
- Payload
Content type
{- "userName": "string",
- "password": "string",
- "oneTimePasscode": "string"
}Response samples
- 200
- 401
- 409
- 500
Content type
No sample
Refreshes an expired access token for continued access
Generates new access token using valid refresh token for continued API access.
Authorizations:
ApiKeyBearer
Request Body schema:
Refresh token model containing the refresh token
| refreshToken | string or null |
Responses
Response Schema:
| accessToken | string or null |
| refreshToken | string or null |
Request samples
- Payload
Content type
{- "refreshToken": "string"
}Response samples
- 200
- 401
Content type
No sample
Resends MFA verification code for authentication
Sends new MFA verification code to user's registered email or phone.
Authorizations:
ApiKeyBearer
Request Body schema:
Resend MFA model containing SID and email for code delivery
| sid required | string non-empty |
string or null |
Responses
Request samples
- Payload
Content type
{- "sid": "string",
- "email": "string"
}Response samples
- 500
Content type
No sample
Was this topic helpful?