Embeddable View
Nected introduces a powerful framework for embedding users and providing pre-signed authentication. These features offer seamless integration and secure access control mechanisms, empowering organizations to embed Nected’s UI components and enable direct sign-ins with pre-signed URLs.
Overview Flow of Embedded Users
Below is the overview on how to generate pre-signed urls to embed rules and workflows within another product.

To integrate Embedded Users Flow with the Embedded View, here's how you can access and manage it for these users:
Add Users To Enable Embeddable Flow
Navigate to Workspace Settings:
Go to the Workspace section in the Nected platform.
Click on the Embedded Users tab under the Workspace menu.
Add Embedded Users:
Input the email address of the user in the "Add user by email" field.
Assign a role using the Select Role dropdown menu.
Click Add User to grant access.
Invitation Expiry & Token Lifecycle
When inviting a team member using the embedded user feature:
The invitation expires in 1 day.
To keep the session live, the admin must use the refresh token.
The refresh token itself expires in 30 days.
Generate Embeddable Signed URL for Users:
For each user added, you can provide access to Embedded Views through the pre-signed authentication URL.
Generate the Pre-signed Token using the provided API.
Endpoint:
(<https://api.nected.ai/dev/signed-token?email=>)<member-email>
HTTP Method: GET
Authentication Parameters
email
String
Yes
User's email address for token generation
nected-api-key
String
Yes
Organization's unique API authentication key
Example Authentication Request
curl --location '<https://api.nected.ai/dev/signed-token?email=%3CEMAIL_ID%3E>' \\
--header 'nected-api-key: {{NECTED_API_KEY}}'
2. Response Structure
When successfully executed, the API returns a comprehensive JSON response containing the pre-signed authentication token:
{
"data": {
"signedURL": "<https://app.nected.ai/signed-url/><<PreSigned-Token>>=?redirect="
},
"code": "success",
"message": "success."
}
Nected's pre-signed authentication supports targeted redirections, allowing administrators to guide users directly to specific platform sections:
/rules
Rule Management Interface
/workflow
Workflow Configuration Dashboard
Example Rule Url:
<https://app.nected.ai/signed-url/><PreSigned-Token>?redirect=/rules
Embed Rule or Workflow listing UI inside your product via iframe
Embed Workflow Example
<iframe
src="<https://app.nected.ai/embed/><PreSigned-Token>?redirect=/workflow"
width="100%"
height="600"
frameborder="0"
allowfullscreen
></iframe>
Hiding Features for Embedded Users
In on-prem deployments, admins can choose to hide specific UI elements from embedded users’ dashboards. The following can be disabled:
Custom Attribute button
Dependency Mapping
Version Control
API Settings
To configure this, update the following fields inside your konark.env
file:
VITE_EMB_HIDE_DU_HELP_SETTINGS=true
VITE_EMB_HIDE_VC=false
VITE_EMB_HIDE_CI=true
Error Handling and Response Codes
Comprehensive Error Classification
The pre-signed authentication API implements a robust error management strategy, providing clear, actionable feedback across various potential failure scenarios:
401
UNAUTHORIZED
Invalid or expired API credentials
Verify API key and regenerate if necessary
500
INTERNAL_SERVER_ERROR
Unexpected system malfunction
Contact Nected technical support
429
TOO_MANY_REQUESTS
Authentication request quota exceeded
Implement exponential backoff strategy
413
REQUEST_ENTITY_TOO_LARGE
Malformed authentication request
Validate request parameters and ensure payload size is within limits
400
BAD_REQUEST
Malformed authentication request
Validate request parameters
INVALID_SIGNED_TOKEN
Triggered when the signed token has expired.
Admin must regenerate a new signed token.
REGENERATE_SIGNED_TOKEN
Triggered when the refresh token has expired.
Admin must regenerate the signed token again in this case.
Best Practices and Recommendations
Implement strict API key rotation policies
Utilize HTTPS for all API interactions
Generate pre-signed URLs dynamically and close to the point of use
Establish clear access governance policies
Regularly audit user access and permissions
Support and Additional Resources
For advanced implementation guidance, architectural consultations, or technical support, please get in touch with Nected's dedicated support team at [email protected]
Last updated