Boomi MFT - AFT Management API Reference (v1) - AdminUsers
Download OpenAPI Specification: Download
Retrieves a specific user by their identifier
Requires instance admin API permissions and user get permissions to retrieve user details.
Authorizations:
ApiKeyBearer
path Parameters
| userId required | integer <int32> Unique identifier of the user to retrieve |
Responses
Response Schema:
| email required | string non-empty |
| firstName required | string non-empty |
| isActive required | boolean |
| isEnabled required | boolean |
| isLogSession required | boolean |
| lastName required | string non-empty |
| username required | string non-empty |
| id | integer <int32> |
| customerId | integer <int32> |
| password | string or null |
| organizationIds | string or null |
| defaultUploadFlowEndpointId | integer or null <int32> |
| roleIds | Array of integers or null <int32> [ items <int32 > ] |
Response samples
- 200
- 403
- 500
Content type
No sample
Retrieves a list of all users in the current customer instance
Requires instance admin API permissions and user get permissions to retrieve users list.
Authorizations:
ApiKeyBearer
Responses
Response Schema:
Array
| id | integer <int32> |
| firstName | string or null |
| lastName | string or null |
| username | string or null |
| isEnabled | boolean |
| isActive | boolean |
| isAdmin | boolean |
| created | string <date-time> |
string or null | |
| customerName | string or null |
| customerId | integer <int32> |
| failedAttempts | integer <int32> |
| bannedUntil | string <date-time> |
| lastLogin | string or null <date-time> |
Response samples
- 200
- 403
- 500
Content type
No sample
Retrieves a list of users for a specific customer identifier
Requires instance admin API permissions and user get permissions.
Authorizations:
ApiKeyBearer
query Parameters
| customerId | integer <int32> Unique identifier of the customer |
Responses
Response Schema:
Array
| id | integer <int32> |
| firstName | string or null |
| lastName | string or null |
| username | string or null |
| isEnabled | boolean |
| isActive | boolean |
| isAdmin | boolean |
| created | string <date-time> |
string or null | |
| customerName | string or null |
| customerId | integer <int32> |
| failedAttempts | integer <int32> |
| bannedUntil | string <date-time> |
| lastLogin | string or null <date-time> |
Response samples
- 200
- 403
- 500
Content type
No sample
Creates a new user in the system
Creates users with different role levels:
- Administrator: Full system access with isAdmin = true
- Instance User: Standard user access with isAdmin = false
- Organization User: Organization-scoped access with organizationIds specified
Example Administrator user: { "firstName": "Admin", "lastName": "User", "username": "admin_user", "email": "admin@example.org", "isEnabled": true, "isAdmin": true, "isActive": true, "isLogSession": true }
Authorizations:
ApiKeyBearer
Request Body schema:
User configuration details including roles and permissions
| email required | string non-empty |
| firstName required | string non-empty |
| isActive required | boolean |
| isEnabled required | boolean |
| isLogSession required | boolean |
| lastName required | string non-empty |
| username required | string non-empty |
| id | integer <int32> |
| customerId | integer <int32> |
| password | string or null |
| organizationIds | string or null |
| defaultUploadFlowEndpointId | integer or null <int32> |
| roleIds | Array of integers or null <int32> [ items <int32 > ] |
Responses
Response Schema:
| email required | string non-empty |
| firstName required | string non-empty |
| isActive required | boolean |
| isEnabled required | boolean |
| isLogSession required | boolean |
| lastName required | string non-empty |
| username required | string non-empty |
| id | integer <int32> |
| customerId | integer <int32> |
| password | string or null |
| organizationIds | string or null |
| defaultUploadFlowEndpointId | integer or null <int32> |
| roleIds | Array of integers or null <int32> [ items <int32 > ] |
Request samples
- Payload
Content type
{- "id": 0,
- "customerId": 0,
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "password": "string",
- "email": "string",
- "isEnabled": true,
- "isActive": true,
- "isLogSession": true,
- "organizationIds": "string",
- "defaultUploadFlowEndpointId": 0,
- "roleIds": [
- 0
]
}Response samples
- 200
- 400
- 403
- 500
Content type
No sample
Updates an existing user's configuration and settings
Required fields for user updates: { "id": valid user id, "customerId": valid customer id, "firstName": "updated_first_name", "lastName": "updated_last_name", "username": "updated_username", "email": "updated_email@example.org", "isEnabled": true, "isActive": true, "isLogSession": true }
Authorizations:
ApiKeyBearer
Request Body schema:
Updated user configuration details
| email required | string non-empty |
| firstName required | string non-empty |
| isActive required | boolean |
| isEnabled required | boolean |
| isLogSession required | boolean |
| lastName required | string non-empty |
| username required | string non-empty |
| id | integer <int32> |
| customerId | integer <int32> |
| password | string or null |
| organizationIds | string or null |
| defaultUploadFlowEndpointId | integer or null <int32> |
| roleIds | Array of integers or null <int32> [ items <int32 > ] |
Responses
Response Schema:
| email required | string non-empty |
| firstName required | string non-empty |
| isActive required | boolean |
| isEnabled required | boolean |
| isLogSession required | boolean |
| lastName required | string non-empty |
| username required | string non-empty |
| id | integer <int32> |
| customerId | integer <int32> |
| password | string or null |
| organizationIds | string or null |
| defaultUploadFlowEndpointId | integer or null <int32> |
| roleIds | Array of integers or null <int32> [ items <int32 > ] |
Request samples
- Payload
Content type
{- "id": 0,
- "customerId": 0,
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "password": "string",
- "email": "string",
- "isEnabled": true,
- "isActive": true,
- "isLogSession": true,
- "organizationIds": "string",
- "defaultUploadFlowEndpointId": 0,
- "roleIds": [
- 0
]
}Response samples
- 200
- 400
- 403
- 500
Content type
No sample
Saves user configuration (creates new or updates existing based on ID)
Performs upsert operation: creates new user if ID is 0, otherwise updates existing user
Authorizations:
ApiKeyBearer
Request Body schema:
User configuration to save
| email required | string non-empty |
| firstName required | string non-empty |
| isActive required | boolean |
| isEnabled required | boolean |
| isLogSession required | boolean |
| lastName required | string non-empty |
| username required | string non-empty |
| id | integer <int32> |
| customerId | integer <int32> |
| password | string or null |
| organizationIds | string or null |
| defaultUploadFlowEndpointId | integer or null <int32> |
| roleIds | Array of integers or null <int32> [ items <int32 > ] |
Responses
Response Schema:
| email required | string non-empty |
| firstName required | string non-empty |
| isActive required | boolean |
| isEnabled required | boolean |
| isLogSession required | boolean |
| lastName required | string non-empty |
| username required | string non-empty |
| id | integer <int32> |
| customerId | integer <int32> |
| password | string or null |
| organizationIds | string or null |
| defaultUploadFlowEndpointId | integer or null <int32> |
| roleIds | Array of integers or null <int32> [ items <int32 > ] |
Request samples
- Payload
Content type
{- "id": 0,
- "customerId": 0,
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "password": "string",
- "email": "string",
- "isEnabled": true,
- "isActive": true,
- "isLogSession": true,
- "organizationIds": "string",
- "defaultUploadFlowEndpointId": 0,
- "roleIds": [
- 0
]
}Response samples
- 200
- 400
- 403
- 500
Content type
No sample
Assigns selected roles to a user
Authorizations:
ApiKeyBearer
Request Body schema:
User role assignment request containing user and role information
| userId | integer <int32> |
Array of objects or null (UserRoleSelection) |
Responses
Response Schema:
| status | integer <int32> |
| severity | integer <int32> (Severity) Enum: 0 1 2 3 4 -1 |
| module | string or null |
| method | string or null |
| message | string or null |
Request samples
- Payload
Content type
{- "userId": 0,
- "userRoleSelectionList": [
- {
- "id": 0,
- "userRoleCode": "string",
- "userRoleDescription": "string",
- "isSelected": true
}
]
}Response samples
- 200
- 400
- 403
- 500
Content type
No sample
Retrieves all available roles that can be assigned to users
Authorizations:
ApiKeyBearer
Responses
Response Schema:
Array
| id | integer <int32> |
| userRoleCode | string or null |
| userRoleDescription | string or null |
| isHidden | boolean |
| deletedDate | string or null <date-time> |
| customerId | integer or null <int32> |
Response samples
- 200
- 403
- 500
Content type
No sample
Retrieves all roles assigned to a specific user
Requires instance admin API permissions and user role get permissions. Retrieves role assignments for the specified user within the current customer context.
Authorizations:
ApiKeyBearer
path Parameters
| userId required | integer <int32> Unique identifier of the user |
Responses
Response Schema:
Array
| id | integer <int32> |
| userId | integer <int32> |
| roleId | integer <int32> |
| 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> |
Response samples
- 200
- 403
- 500
Content type
No sample
Retrieves session history for a specific user
Authorizations:
ApiKeyBearer
path Parameters
| userId required | integer <int32> Unique identifier of the user |
Responses
Response Schema:
Array
| id | integer <int32> |
| userId | integer <int32> |
| lastAction | string <date-time> |
| created | string <date-time> |
| isLoggedOut | boolean or null |
| isTimedOut | boolean or null |
| terminated | string or null <date-time> |
| ipAddress | string or null |
| userAgent | string or null |
Response samples
- 200
- 403
- 404
- 500
Content type
No sample
Was this topic helpful?
