Soracom Flux

Soracom API Action

The Flux Soracom API Action executes a specified Soracom API with the permissions of a SAM User.

Configuration

Condition

In the Action Condition section, you can specify the conditions under which the action will be executed using the values (Message or Context) from the event source to the channel. For more details on the expressions you can input, please refer to Action Condition Expressions.

In this input field, you can enter expressions representing data related to the trigger that starts the Flux application (e.g., event.payload.temp) or data related to the channel where the action is added (e.g., payload.temp).

Config

Configure the settings for the Soracom API Action.

• API: Select the Soracom API you want to execute from the searchable dropdown.

  Refer to the API Reference for the list of APIs and detailed information.

  As a Flux Soracom API Action executes a specified Soracom API with the permissions of a SAM User, the action cannot execute certain APIs which can be executed by the root user.

  Certain APIs listed in the API Reference are not available for that reason (e.g., Operator:getOperator API, Auth:* API, Query:* API).

• URL: Confirm the HTTP method and path of the selected API.

  When a Soracom API Action executes, it calls an API to perform a task (e.g. update account settings, create a payload).

  If the URL contains placeholders, ensure you replace them with a value or variable.

  For example, for /v1/sims/{sim_id}/downlink/ping, replace {sim_id} with an ICCID such as 8942310000012345678.

  In this field, you can also use expressions to represent data related to the trigger that activated the Flux application (e.g., ${event.payload.temp}) or data related to the channel where the action was added (e.g., ${payload.temp}). For details on supported expressions, refer to Action Config Expressions.

  If the API supports query parameters, you can append them directly to the URL. For example, you can use ?limit=1 or ?tag_name=name&tag_value=test. The available parameters depend on the specific API you're calling. For details, refer to the API Reference.

• HTTP Body: Specify the HTTP body.

  Availability as an input field depends on the selected API. Refer to the API Reference for details.

  You can enter expressions that represent data related to the trigger that launches the Flux app for example, ${event.payload.temp} or expressions that represent data related to the channel to which the action is added for example, ${payload.temp}.

  The FileEntry:putFile API normally allows transferring binary files, but this is not possible through a Soracom API Action.

  The Soracom API Action's request body is sent as content-type: application/json, meaning that binary files will not be processed through the action.

• I understand the above and use this action: Agree to the warning about API calls.

  If you're in agreement and ready to move on, click I understand the above and use this action to continue.

  Using the Soracom API Action itself is free, but executing certain APIs may incur additional charges. Before proceeding, please review the API documentation and pricing details to understand any potential costs.

  Acknowledge and accept any associated charges before clicking .

• SAM User to Execute API: Create or select a SAM User.

  Choose Create a new SAM User or Select a Sam User for this action.

  For Create a new SAM User, use the automatically generated name or enter the user's name in the SAM User Name field. The permissions and Trust Policy for executing the selected API are automatically set and readily usable.

  For Select a SAM User, ensure the Trust Policy is correctly configured. Only SAM Users with statements[].principal.service set to Flux will appear in the selection list.

  • The Permissions tab should include a statement allowing the SAM User to execute the chosen API. For example, to allow execution of the Group:listGroups API:

    {
      "statements": [
        {
          "effect": "allow",
          "api": [
            "Group:listGroups"
          ]
        }
      ]
    }

  • The Trust Policy must explicitly allow the SAM User permissions to use Flux. For example:

    {
      "statements": [
        {
          "effect": "allow",
          "principal": {
            "service": [
              "Flux"
            ]
          }
        }
      ]
    }

  When selecting an existing SAM User, its Permissions and Trust Policy remain unchanged. Verify that these settings are correctly configured before using the Soracom API action.

  To view permissions: Click your account menu, then select Security. Choose a SAM User and view settings in the Permissions and Trust policy tabs.

Output

Configure how to handle the output data of the action. Refer to Enable Republishing of Action Output for more details.

Output Data of the Action

The output data of a Soracom API action is the response body of the executed API, which varies by API. Refer to the API Reference for details.