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

Toggle Pane

• FlowEndpointServerUsers
  • getRetrieves a specific server user configuration by ID
  • delDeletes a specific server user configuration
  • getRetrieves all server user configurations for a specific flow endpoint
  • postCreates a new server user configuration for a flow endpoint
  • putUpdates an existing server user configuration for a flow endpoint
  • putSaves server user configuration (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.

FlowEndpointServerUsers

Retrieves a specific server user configuration by ID

Returns server user configuration including username, authentication type, and credentials.

Authorizations:

ApiKeyBearer

path Parameters

flowEndpointServerUserId required

integer <int32> Unique identifier of the server user configuration

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
isEnabled	boolean
username	string or null
authTypeId	integer or null <int32>
userPassword	string or null
certificateId	integer or null <int32>
sshKeyId	integer or null <int32>
description	string or null
createdBy	string or null
createdDate	string or null <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/FlowEndpointServerUsers/{flowEndpointServerUserId}

https://uk.thruinc.com/api/FlowEndpointServerUsers/{flowEndpointServerUserId}

https://eu.thruinc.com/api/FlowEndpointServerUsers/{flowEndpointServerUserId}

https://au.thruinc.com/api/FlowEndpointServerUsers/{flowEndpointServerUserId}

Response samples

• 200
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Deletes a specific server user configuration

Removes server user configuration from flow endpoint.

Authorizations:

ApiKeyBearer

path Parameters

flowEndpointServerUserId required

integer <int32> Unique identifier of the server user configuration to delete

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/FlowEndpointServerUsers/{flowEndpointServerUserId}

https://uk.thruinc.com/api/FlowEndpointServerUsers/{flowEndpointServerUserId}

https://eu.thruinc.com/api/FlowEndpointServerUsers/{flowEndpointServerUserId}

https://au.thruinc.com/api/FlowEndpointServerUsers/{flowEndpointServerUserId}

Response samples

• 200
• 401
• 403
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves all server user configurations for a specific flow endpoint

Returns list of server user configurations for a flow endpoint.

Authorizations:

ApiKeyBearer

query Parameters

flowEndpointId

integer <int32> Unique identifier of the flow endpoint

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

Array

id	integer <int32>
flowEndpointId	integer <int32>
isEnabled	boolean
username	string or null
authTypeId	integer or null <int32>
userPassword	string or null
certificateId	integer or null <int32>
sshKeyId	integer or null <int32>
description	string or null
createdBy	string or null
createdDate	string or null <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/FlowEndpointServerUsers/getFlowEndpointServerUsersList

https://uk.thruinc.com/api/FlowEndpointServerUsers/getFlowEndpointServerUsersList

https://eu.thruinc.com/api/FlowEndpointServerUsers/getFlowEndpointServerUsersList

https://au.thruinc.com/api/FlowEndpointServerUsers/getFlowEndpointServerUsersList

Response samples

• 200
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Creates a new server user configuration for a flow endpoint

Establishes new server user with authentication credentials and access settings.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Server user configuration details including credentials and access settings

id	integer <int32>
flowEndpointId	integer <int32>
isEnabled	boolean
username	string or null
authTypeId	integer or null <int32>
userPassword	string or null
certificateId	integer or null <int32>
sshKeyId	integer or null <int32>
description	string or null
createdBy	string or null
createdDate	string or null <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

id	integer <int32>
flowEndpointId	integer <int32>
isEnabled	boolean
username	string or null
authTypeId	integer or null <int32>
userPassword	string or null
certificateId	integer or null <int32>
sshKeyId	integer or null <int32>
description	string or null
createdBy	string or null
createdDate	string or null <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/FlowEndpointServerUsers

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

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

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

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "flowEndpointId": 0,
• "isEnabled": true,
• "username": "string",
• "authTypeId": 0,
• "userPassword": "string",
• "certificateId": 0,
• "sshKeyId": 0,
• "description": "string",
• "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
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Updates an existing server user configuration for a flow endpoint

Modifies existing server user configuration including credentials and authentication type.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Updated server user configuration details

id	integer <int32>
flowEndpointId	integer <int32>
isEnabled	boolean
username	string or null
authTypeId	integer or null <int32>
userPassword	string or null
certificateId	integer or null <int32>
sshKeyId	integer or null <int32>
description	string or null
createdBy	string or null
createdDate	string or null <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

id	integer <int32>
flowEndpointId	integer <int32>
isEnabled	boolean
username	string or null
authTypeId	integer or null <int32>
userPassword	string or null
certificateId	integer or null <int32>
sshKeyId	integer or null <int32>
description	string or null
createdBy	string or null
createdDate	string or null <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/FlowEndpointServerUsers

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

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

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

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "flowEndpointId": 0,
• "isEnabled": true,
• "username": "string",
• "authTypeId": 0,
• "userPassword": "string",
• "certificateId": 0,
• "sshKeyId": 0,
• "description": "string",
• "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
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Saves server user configuration (creates new or updates existing based on ID)

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

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Server user configuration to save (performs upsert based on record ID)

id	integer <int32>
flowEndpointId	integer <int32>
isEnabled	boolean
username	string or null
authTypeId	integer or null <int32>
userPassword	string or null
certificateId	integer or null <int32>
sshKeyId	integer or null <int32>
description	string or null
createdBy	string or null
createdDate	string or null <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

id	integer <int32>
flowEndpointId	integer <int32>
isEnabled	boolean
username	string or null
authTypeId	integer or null <int32>
userPassword	string or null
certificateId	integer or null <int32>
sshKeyId	integer or null <int32>
description	string or null
createdBy	string or null
createdDate	string or null <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/FlowEndpointServerUsers/save

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

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

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

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "flowEndpointId": 0,
• "isEnabled": true,
• "username": "string",
• "authTypeId": 0,
• "userPassword": "string",
• "certificateId": 0,
• "sshKeyId": 0,
• "description": "string",
• "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
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample