milesoft integration

Retrieve, create, update, and delete integration configurations.

milesoft integration list

Retrieve a paginated collection of integrations currently registered in the platform.

• Usage: milesoft integration list [flags]

Examples

Terminal TTY Tabular Output (Default)

$ milesoft integration list
=======================================================================================================
INTEGRATION ID       NAME               TYPE         ENV      CREATED             UPDATED            
=======================================================================================================
int-101              Hubspot Integrat... Account      Sand     2026-07-17 15:20:00 2026-07-17 15:20:00
int-102              Salesforce         User         Prod     2026-07-17 16:00:00 2026-07-17 16:30:00
=======================================================================================================
End of collection (limit 50)

Automated JSON Output (via Pipe, Redirect, or --json)

$ milesoft integration list --json

JSON Schema Result:

[
  {
    "id": "int-101",
    "title": "Hubspot Integration",
    "authUrl": "https://app.hubspot.com/oauth/authorize",
    "tokenUrl": "https://api.hubapi.com/oauth/v1/token",
    "redirectUrl": "https://callback",
    "clientId": "id-xyz",
    "scope": "contacts",
    "type": "Account",
    "environment": "Sand",
    "ephemeral": false,
    "created": "2026-07-17T15:20:00Z",
    "updated": "2026-07-17T15:20:00Z"
  },
  {
    "id": "int-102",
    "title": "Salesforce",
    "authUrl": "https://login.salesforce.com/services/oauth2/authorize",
    "tokenUrl": "https://login.salesforce.com/services/oauth2/token",
    "redirectUrl": "https://callback-sf",
    "clientId": "sf-client-id",
    "scope": "api",
    "type": "User",
    "environment": "Prod",
    "ephemeral": true,
    "created": "2026-07-17T16:00:00Z",
    "updated": "2026-07-17T16:30:00Z"
  }
]

milesoft integration get

Retrieve the full details of a specific integration by its ID.

• Usage: milesoft integration get <integration-id> [flags]

Examples

Terminal TTY Output (Default)

$ milesoft integration get int-101
=========================================================================
             Integration
=========================================================================
ID:            int-101
Name:          Hubspot Integration
Type:          Account
Environment:   Sand
Ephemeral:     false
-------------------------------------------------------------------------
Auth URL:      https://app.hubspot.com/oauth/authorize
Token URL:     https://api.hubapi.com/oauth/v1/token
Redirect URL:  https://callback
Client ID:     id-xyz
Client Secret: (redacted)
Scope:         contacts
-------------------------------------------------------------------------
Parameters:
  key1 = value1
  key2 = value2
-------------------------------------------------------------------------
Created:       2026-07-17T15:20:00Z
Updated:       2026-07-17T15:20:00Z
=========================================================================

Automated JSON Output (via Pipe, Redirect, or --json)

$ milesoft integration get int-101 --json

JSON Schema Result:

{
  "id": "int-101",
  "title": "Hubspot Integration",
  "authUrl": "https://app.hubspot.com/oauth/authorize",
  "tokenUrl": "https://api.hubapi.com/oauth/v1/token",
  "redirectUrl": "https://callback",
  "clientId": "id-xyz",
  "scope": "contacts",
  "type": "Account",
  "environment": "Sand",
  "ephemeral": false,
  "parameters": [
    {
      "key": "key1",
      "value": "value1"
    },
    {
      "key": "key2",
      "value": "value2"
    }
  ],
  "created": "2026-07-17T15:20:00Z",
  "updated": "2026-07-17T15:20:00Z"
}

Field-Specific Raw Output (via --field Flag)

Pairs perfectly with shell utilities (like pbcopy, env assignments, or scripting) by performing a case-insensitive match and outputting the raw, unquoted value.

$ milesoft integration get int-101 --field authUrl
https://app.hubspot.com/oauth/authorize

milesoft integration create

Create a new integration.

• Usage: milesoft integration create [flags]
• Sub-flags (All of the following are Required except --parameters and --ephemeral):
  • --auth-url string: Authorization URL.
  • --client-id string: Client ID.
  • --client-secret string: Client Secret.
  • --environment string: Environment: Sand or Prod.
  • --ephemeral: Whether tokens are ephemeral.
  • --parameters string: Additional parameters as JSON array, e.g. [{"key":"k","value":"v"}].
  • --redirect-url string: Redirect URL.
  • --scope string: OAuth scope string.
  • --title string: Title of the integration.
  • --token-url string: Token URL.
  • --type string: Integration type: Account or User.

Examples

Provisioning an Integration

$ milesoft integration create --title "Hubspot Integration" --client-id "id-xyz" --client-secret "sec-abc" \
  --auth-url "https://app.hubspot.com/oauth/authorize" --token-url "https://api.hubapi.com/oauth/v1/token" \
  --redirect-url "https://callback" --scope "contacts" --environment Sand --type Account
=========================================================================
             Created Integration
=========================================================================
ID:            int-101
Name:          Hubspot Integration
Type:          Account
Environment:   Sand
Created:       2026-07-17T15:20:00Z
=========================================================================

JSON Response for Scripted Creation (using --json)

$ milesoft integration create --title "Hubspot Integration" --client-id "id-xyz" --client-secret "sec-abc" \
  --auth-url "https://app.hubspot.com/oauth/authorize" --token-url "https://api.hubapi.com/oauth/v1/token" \
  --redirect-url "https://callback" --scope "contacts" --environment Sand --type Account --json

JSON Schema Result:

{
  "id": "int-101",
  "title": "Hubspot Integration",
  "authUrl": "https://app.hubspot.com/oauth/authorize",
  "tokenUrl": "https://api.hubapi.com/oauth/v1/token",
  "redirectUrl": "https://callback",
  "clientId": "id-xyz",
  "scope": "contacts",
  "type": "Account",
  "environment": "Sand",
  "ephemeral": false,
  "created": "2026-07-17T15:20:00Z",
  "updated": "2026-07-17T15:20:00Z"
}

milesoft integration update

Partially update an integration. Only provided flags will be updated. At least one modification flag must be explicitly provided, otherwise the command will fail.

• Usage: milesoft integration update <integration-id> [flags]
• Sub-flags:
  • --auth-url string: New authorization URL.
  • --client-id string: New client ID.
  • --client-secret string: New client secret.
  • --environment string: Environment: Sand or Prod.
  • --ephemeral: Whether tokens are ephemeral.
  • --redirect-url string: New redirect URL.
  • --scope string: New OAuth scope string.
  • --title string: New title of the integration.
  • --token-url string: New token URL.
  • --type string: Integration type: Account or User.

Examples

Updating Integration Settings

$ milesoft integration update int-101 --title "Updated Hubspot Integration" --environment Prod
=========================================================================
             Updated Integration
=========================================================================
ID:            int-101
Name:          Updated Hubspot Integration
Type:          Account
Environment:   Prod
Updated:       2026-07-17T15:30:00Z
=========================================================================

JSON Response for Scripted Update (using --json)

$ milesoft integration update int-101 --title "Updated Hubspot Integration" --json

JSON Schema Result:

{
  "id": "int-101",
  "title": "Updated Hubspot Integration",
  "authUrl": "https://app.hubspot.com/oauth/authorize",
  "tokenUrl": "https://api.hubapi.com/oauth/v1/token",
  "redirectUrl": "https://callback",
  "clientId": "id-xyz",
  "scope": "contacts",
  "type": "Account",
  "environment": "Sand",
  "ephemeral": false,
  "created": "2026-07-17T15:20:00Z",
  "updated": "2026-07-17T15:30:00Z"
}

Triggering No Modification Flags Error

If the command is invoked without any modification flags, it will fail:

$ milesoft integration update int-101
Error: no modification flags provided

milesoft integration delete

Permanently delete an integration by its ID. To prevent accidental data loss in production, this command interactively prompts the user for confirmation unless bypassed using the global -y/--yes flag.

• Usage: milesoft integration delete <integration-id> [flags]

Examples

Deleting Interactively

$ milesoft integration delete int-101
Are you sure you want to delete integration int-101? (y/N): y
Success! Integration int-101 has been deleted.

Interactive Delete Cancellation

$ milesoft integration delete int-101
Are you sure you want to delete integration int-101? (y/N): n
Delete cancelled.

Bypassing Prompts for Automation

$ milesoft integration delete int-101 --yes
Success! Integration int-101 has been deleted.