Straddle icon

Straddle

Interact with Straddle API

Actions81

Overview

This node operation updates (patches) an existing user record in a system via an API. It allows modifying various user attributes such as name, email, organization affiliation, roles, and authenticator details by specifying the user's unique identifier. This is useful in scenarios where user information needs to be corrected or updated without replacing the entire user record.

Practical examples include:

  • Updating a user's email address after they change it.
  • Assigning new roles to a user to modify their permissions.
  • Changing the organization a user belongs to when they move departments.

Properties

Name Meaning
User Id The unique identifier of the user to update (required).
Request Id Optional client-generated identifier for tracing and debugging this specific request.
Correlation Id Optional client-generated identifier to trace and debug a series of related requests.
First Name The user's first name.
Organization Id Unique identifier of the organization the user belongs to.
Platform Id Identifier related to the platform associated with the user.
Last Name The user's last name.
Email The user's email address.
Authenticator Id Unique identifier linked to the user's authenticator.
Roles JSON array representing the list of roles assigned to the user.

Output

The node outputs JSON data representing the updated user object returned from the API after the patch operation. This typically includes the user's current state with all updated fields.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authentication to the Straddle API.
  • The base URL for API requests is dynamically set based on the environment credential parameter.
  • The node sends HTTP PATCH requests with JSON payloads to update user data.

Troubleshooting

  • Missing User Id: The operation requires a valid user ID; omitting it will cause errors.
  • Invalid JSON in Roles: The roles property expects a JSON array; malformed JSON will cause parsing errors.
  • Authentication Errors: Ensure the API key credential is correctly configured and has sufficient permissions.
  • API Endpoint Issues: Verify the environment setting matches the correct API base URL.
  • Request/Correlation Ids: These are optional but useful for tracing; incorrect usage won't break the request but may hinder debugging.

Common error messages might include:

  • "User not found" if the user ID does not exist.
  • "Unauthorized" if the API key is invalid or missing.
  • "Bad Request" if required fields are missing or JSON is malformed.

Links and References

  • Straddle API Documentation (hypothetical link)
  • n8n HTTP Request Node documentation for understanding PATCH requests and header routing.

Discussion