Boomi Flow (v1)

Admin

Reset Password

The password reset API is only applicable to Flow Builders. For running users, the user identity is managed
by the underlying Service (e.g. Salesforce, Box, Google), and therefore user resets should be performed on
the underlying system, not within ManyWho. The password reset API requires two separate API calls to
complete. The first API call sends the user the password reset notification. The second API call performs
the actual password change, based on the token provided in the notification.

If a notification is provided, the redirectUrl property should include two parameters in the
content - one for the notification result ({0}) and one for the reset token ({1}).
The platform will automatically parse the notification result and callbackUri values at these
positions in the content.

The result parameter has the following possible values:

OK: The password reset was correctly processed

ALREADY_PROCESSED: The password reset token has already been processed by the Platform and the user is re-using the link

To add the password verification URL to the notification, simply add PASSWORD_URL_HERE to the content of
the message and the platform will replace this with the actual verification callback URL, which will in turn
forward to the redirectUrl.

query Parameters

email

string

The email address of the account to initialize a password reset for

Request Body schema: application/json

notificationMessages

Array of object (NotificationMessageAPI)

The list of notification messages to be sent.

reason

string

The reason for the notification. Typically, the reason will be provided as the 'subject' for email notifications.

redirectUrl

string

The Url to redirect the user to once this notification has been processed by the platform.

Responses

200

Success

post/api/admin/1/directory/user/password

https://flow.manywho.com/api/admin/1/directory/user/password

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"notificationMessages":

[

{

"mediaType": "string",

"message": "string"

}

],

"reason": "string",

"redirectUrl": "string"

}

Apply Password Reset

Apply the actual password change for an account, using the token generated from the notification callback
sent in the "Reset Password" endpoint.

The token is not provided in the notification, but rather the token is provided after the user clicks on the
notification link. The token will either be parsed into the provided redirectUrl (if specified)
or provided in the REST response from a GET request to the notification callback URL provided in the
notification.

path Parameters

token

required

string <uuid>

The token that was provided to the user as part of the notification callback

Responses

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"password": "string"

}

Response samples

200

application/json

Copy

Expand all Collapse all

true

Provisioning

Provision a Tenant

This endpoint provisions a new tenant, and also creates a new user if one doesn't exist with the given email
address. If a value is given for the notification object, then the provisioning email sent to the user will
be overridden with the provided message.

Request Body schema: application/json

email

string

The email of the user

firstName

string

The first name of the user

lastName

string

The last name of the user

notification

object (NotificationRequestAPI)

password

string

The password for the user

subdomain

string

An optional, globally unique subdomain to reserve for this tenant

tenantName

string

The name of the tenant to create

Responses

200

Success

post/api/admin/1/provisioning

https://flow.manywho.com/api/admin/1/provisioning

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"email": "string",

"firstName": "string",

"lastName": "string",

"notification":

{

"notificationMessages":

[

{

"mediaType": "string",

"message": "string"

}

],

"reason": "string",

"redirectUrl": "string"

},

"password": "string",

"subdomain": "string",

"tenantName": "string"

}

States

The flow state object provides data about a specific instance of a running flow

A flow state provides in-depth information about how users have interacted with a flow, from the data that has
been collected in values, to the path of map elements that were travelled, to the users who have interacted with
the flow at the various stages of its execution. Flow state data is only available for active flows that have
not yet completed.

This API should also not be used for reporting purposes as we have a separate reporting API and reporting
infrastructure.

List States

Get a listing of all the flow states in the current tenant.

query Parameters

pageSize

required

integer <int32>

The number of states to return

page

required

integer <int32>

The current page of states

status

string

The status of the states to filter by

from

string <date-time>

An ISO 8601 datetime to filter states from

to

string <date-time>

An ISO 8601 datetime to filter states until

Responses

200

Success

get/api/admin/1/states

https://flow.manywho.com/api/admin/1/states

Response samples

200

application/json

Copy

Expand all Collapse all

{

"_links":

{

"property1": "string",

"property2": "string"

},

"_meta":

{

"property1": { },

"property2": { }

},

"items":

[

{

"annotations":

{

"property1": "string",

"property2": "string"

},

"authorizationHeader": "string",

"currentFlowDeveloperName": "string",

"currentFlowId":

{

"id": "string",

"versionId": "string"

},

"currentMapElementDeveloperName": "string",

"currentMapElementId": "string",

"currentRunningUserEmail": "string",

"currentRunningUserId": "string",

"currentStreamId": "string",

"dateCreated": "2019-02-11T16:32:22Z",

"dateModified": "2019-02-11T16:32:22Z",

"expiresAt": "2019-02-11T16:32:22Z",

"externalIdentifier": "string",

"hasRootFaults": true,

"id": "string",

"isDone": true,

"isExpired": true,

"joinUri": "string",

"log":

{

"developerName": "string",

"developerSummary": "string",

"elementType": "string",

"entries":

{

"property1":

{

"data": "string",

"developerName": "string",

"developerSummary": "string",

"elementType": "string",

"id": "string",

"level": "info",

"message": "string",

"timestamp": "2019-02-11T16:32:22Z"

},

"property2":

{

"data": "string",

"developerName": "string",

"developerSummary": "string",

"elementType": "string",

"id": "string",

"level": "info",

"message": "string",

"timestamp": "2019-02-11T16:32:22Z"

}

},

"flowDeveloperName": "string",

"flowId": "string",

"id": "string",

"stateId": "string"

},

"manywhoTenantId": "string",

"parentId": "string",

"precommitStateEntry":

{

"dateCommitted": "2019-02-11T16:32:22Z",

"flowDeveloperName": "string",

"flowId":

{

"id": "string",

"versionId": "string"

},

"id": "string",

"mapElementDeveloperName": "string",

"mapElementId": "string",

"userInteractions":

[

{

"accuracy": 0,

"altitude": 0,

"altitudeAccuracy": 0,

"heading": 0,

"latitude": 0,

"longitude": 0,

"manywhoUserId": "string",

"speed": 0,

"time": "2019-02-11T16:32:22Z"

}

],

"values":

[

{

"contentType": "string",

"contentValue": "string",

"objectData":

[

{

"developerName": "string",

"externalId": "string",

"internalId": "string",

"isSelected": true,

"order": 0,

"properties":

[

{

"contentFormat": "string",

"contentType": "string",

"contentValue": "string",

"developerName": "string",

"objectData":

[

{ }

],

"typeElementId": "string",

"typeElementPropertyId": "string"

}

],

"typeElementId": "string"

}

],

"valueElementDeveloperName": "string",

"valueElementId": "string"

}

]

},

"rootFaults":

{

"property1": "string",

"property2": "string"

},

"stateEntries":

[

{

"dateCommitted": "2019-02-11T16:32:22Z",

"flowDeveloperName": "string",

"flowId":

{

"id": "string",

"versionId": "string"

},

"id": "string",

"mapElementDeveloperName": "string",

"mapElementId": "string",

"userInteractions":

[

{

"accuracy": 0,

"altitude": 0,

"altitudeAccuracy": 0,

"heading": 0,

"latitude": 0,

"longitude": 0,

"manywhoUserId": "string",

"speed": 0,

"time": "2019-02-11T16:32:22Z"

}

],

"values":

[

{

"contentType": "string",

"contentValue": "string",

"objectData":

[

{

"developerName": "string",

"externalId": "string",

"internalId": "string",

"isSelected": true,

"order": 0,

"properties":

[

{

"contentFormat": "string",

"contentType": "string",

"contentValue": "string",

"developerName": "string",

"objectData":

[

{ }

],

"typeElementId": "string",

"typeElementPropertyId": "string"

}

],

"typeElementId": "string"

}

],

"valueElementDeveloperName": "string",

"valueElementId": "string"

}

]

}

],

"storeId": "string",

"values":

[

{

"contentType": "string",

"contentValue": "string",

"objectData":

[

{

"developerName": "string",

"externalId": "string",

"internalId": "string",

"isSelected": true,

"order": 0,

"properties":

[

{

"contentFormat": "string",

"contentType": "string",

"contentValue": "string",

"developerName": "string",

"objectData":

[

{ }

],

"typeElementId": "string",

"typeElementPropertyId": "string"

}

],

"typeElementId": "string"

}

],

"valueElementDeveloperName": "string",

"valueElementId": "string"

}

]

}

]

}

Delete Multiple States

Delete multiple flow states

Request Body schema: application/json

Array

string <uuid>

Responses

200

Success

delete/api/admin/1/states

https://flow.manywho.com/api/admin/1/states

Request samples

Payload

application/json

Copy

Expand all Collapse all

[

"string"

]

Load State

Load an individual flow state

path Parameters

id

required

string <uuid>

The ID of the state to load

Responses

200

Success

get/api/admin/1/states/{id}

https://flow.manywho.com/api/admin/1/states/{id}

Response samples

200

application/json

Copy

Expand all Collapse all

{

"annotations":

{

"property1": "string",

"property2": "string"

},

"authorizationHeader": "string",

"currentFlowDeveloperName": "string",

"currentFlowId":

{

"id": "string",

"versionId": "string"

},

"currentMapElementDeveloperName": "string",

"currentMapElementId": "string",

"currentRunningUserEmail": "string",

"currentRunningUserId": "string",

"currentStreamId": "string",

"dateCreated": "2019-02-11T16:32:22Z",

"dateModified": "2019-02-11T16:32:22Z",

"expiresAt": "2019-02-11T16:32:22Z",

"externalIdentifier": "string",

"hasRootFaults": true,

"id": "string",

"isDone": true,

"isExpired": true,

"joinUri": "string",

"log":

{

"developerName": "string",

"developerSummary": "string",

"elementType": "string",

"entries":

{

"property1":

{

"data": "string",

"developerName": "string",

"developerSummary": "string",

"elementType": "string",

"id": "string",

"level": "info",

"message": "string",

"timestamp": "2019-02-11T16:32:22Z"

},

"property2":

{

"data": "string",

"developerName": "string",

"developerSummary": "string",

"elementType": "string",

"id": "string",

"level": "info",

"message": "string",

"timestamp": "2019-02-11T16:32:22Z"

}

},

"flowDeveloperName": "string",

"flowId": "string",

"id": "string",

"stateId": "string"

},

"manywhoTenantId": "string",

"parentId": "string",

"precommitStateEntry":

{

"dateCommitted": "2019-02-11T16:32:22Z",

"flowDeveloperName": "string",

"flowId":

{

"id": "string",

"versionId": "string"

},

"id": "string",

"mapElementDeveloperName": "string",

"mapElementId": "string",

"userInteractions":

[

{

"accuracy": 0,

"altitude": 0,

"altitudeAccuracy": 0,

"heading": 0,

"latitude": 0,

"longitude": 0,

"manywhoUserId": "string",

"speed": 0,

"time": "2019-02-11T16:32:22Z"

}

],

"values":

[

{

"contentType": "string",

"contentValue": "string",

"objectData":

[

{

"developerName": "string",

"externalId": "string",

"internalId": "string",

"isSelected": true,

"order": 0,

"properties":

[

{

"contentFormat": "string",

"contentType": "string",

"contentValue": "string",

"developerName": "string",

"objectData":

[

{ }

],

"typeElementId": "string",

"typeElementPropertyId": "string"

}

],

"typeElementId": "string"

}

],

"valueElementDeveloperName": "string",

"valueElementId": "string"

}

]

},

"rootFaults":

{

"property1": "string",

"property2": "string"

},

"stateEntries":

[

{

"dateCommitted": "2019-02-11T16:32:22Z",

"flowDeveloperName": "string",

"flowId":

{

"id": "string",

"versionId": "string"

},

"id": "string",

"mapElementDeveloperName": "string",

"mapElementId": "string",

"userInteractions":

[

{

"accuracy": 0,

"altitude": 0,

"altitudeAccuracy": 0,

"heading": 0,

"latitude": 0,

"longitude": 0,

"manywhoUserId": "string",

"speed": 0,

"time": "2019-02-11T16:32:22Z"

}

],

"values":

[

{

"contentType": "string",

"contentValue": "string",

"objectData":

[

{

"developerName": "string",

"externalId": "string",

"internalId": "string",

"isSelected": true,

"order": 0,

"properties":

[

{

"contentFormat": "string",

"contentType": "string",

"contentValue": "string",

"developerName": "string",

"objectData":

[

{ }

],

"typeElementId": "string",

"typeElementPropertyId": "string"

}

],

"typeElementId": "string"

}

],

"valueElementDeveloperName": "string",

"valueElementId": "string"

}

]

}

],

"storeId": "string",

"values":

[

{

"contentType": "string",

"contentValue": "string",

"objectData":

[

{

"developerName": "string",

"externalId": "string",

"internalId": "string",

"isSelected": true,

"order": 0,

"properties":

[

{

"contentFormat": "string",

"contentType": "string",

"contentValue": "string",

"developerName": "string",

"objectData":

[

{ }

],

"typeElementId": "string",

"typeElementPropertyId": "string"

}

],

"typeElementId": "string"

}

],

"valueElementDeveloperName": "string",

"valueElementId": "string"

}

]

}

Delete State

Delete an individual flow state

path Parameters

id

required

string <uuid>

The ID of the state to delete

Responses

200

Success

delete/api/admin/1/states/{id}

https://flow.manywho.com/api/admin/1/states/{id}

List States by Flow

Get a listing of all the flow states grouped by flow in the current tenant.

query Parameters

pageSize

required

integer <int32>

The number of flow states to return

page

required

integer <int32>

The current page of flow states

orderBy

string

The column to order the results by

orderDirection

string

The direction the order will use

status

string

The status of the state to filter by

from

string <date-time>

An ISO 8601 datetime to filter results from

to

string <date-time>

An ISO 8601 datetime to filter results until

Responses

200

Success

get/api/admin/1/states/flow

https://flow.manywho.com/api/admin/1/states/flow

Response samples

200

application/json

Copy

Expand all Collapse all

{

"_links":

{

"property1": "string",

"property2": "string"

},

"_meta":

{

"property1": { },

"property2": { }

},

"items":

[

{

"count": 0,

"developerName": "string",

"id": "string"

}

]

}

List States for a Flow

Get a listing of all the flow states for a specific flow in the current tenant.