Once the Assette Block Editor extension has been successfully installed in Visual Studio Code (VS Code), the next critical step is authenticating with Single Sign-On (SSO). SSO is required to access any functionality within the extension, including downloading, editing, or uploading Assette content blocks. This guide walks you through the complete SSO sign-in process, requirements, troubleshooting tips, and security considerations to ensure you can securely and reliably begin using the extension.
Prerequisites #
Before attempting to sign in with SSO, confirm that the following requirements are met:
- VS Code is Installed: Refer to Visual Studio Code Setup if needed.
- Assette Block Editor Extension is Installed: The extension must be installed and must be version 0.0.8 or higher. Refer to Installing and Setting Up the Assette Block Editor VS Code Extension for more information.
- Internet Access: A stable internet connection is required to authenticate via your browser.
- Client ID: You must have your firm’s Assette Client ID, or a value specific to your organization.
- SSO Access: You must be set up with SSO credentials through your organization’s identity provider (such as Azure Active Directory, Okta, or OneLogin).
Important: The extension will not function without successful SSO authentication. Logging in is mandatory for any further action.
Steps to Sign In with SSO #
Step 1: Open the Extension Panel #
- Launch Visual Studio Code.
- Click the Assette icon in the Activity Bar (left sidebar). This opens the Assette extension panel.
If the icon is not visible:
- Go to the Extensions tab (Ctrl+Shift+X or Cmd+Shift+X).
- Search for and confirm the Assette Block Editor is installed.
- If installed but not visible, reload or restart VS Code.
Step 2: Initiate the Sign-In Process #
In the Assette extension panel:
- Click the Sign In button.
- A prompt will appear requesting your Client ID.
- Enter your organization’s unique Assette Client ID (e.g.,
MODL
,BYOD
). - This ID identifies the correct environment for your firm’s SSO authentication flow.
- Enter your organization’s unique Assette Client ID (e.g.,
- Press
Enter
or click to continue.
Step 3: Complete Browser-Based SSO Authentication #
After entering your Client ID:
- Your default browser will open a secure login page.
- You will be redirected to your organization’s SSO provider login screen.
- Log in using your corporate credentials (e.g., company email and password or identity provider MFA).
Upon successful authentication:
- The browser window will confirm login success.
- You will be automatically redirected back to Visual Studio Code.
Step 4: Confirm Authentication in VS Code #
After completing the login:
- Return to VS Code.
- The Assette extension panel should now display:
- A hierarchical tree view of blocks and folders.
- The toolbar with key functions: Download, Upload, Refresh, and Sign Out.
- You are now fully authenticated and ready to begin managing Assette blocks.
What Happens After Signing In #
Once authenticated:
- The extension retrieves and displays a tree view of block files available for your account.
- You are able to download and edit Python, text, and other supported blocks.
- Uploading your updates to Assette is now enabled.
All authenticated sessions persist until explicitly signed out or until the session expires due to inactivity or token expiry.
Troubleshooting Sign-In Issues #
If you encounter issues during the SSO sign-in process:
The browser does not open: #
- Ensure your system allows applications to open external URLs.
- Try right-clicking the Sign In button and selecting Copy Link, then manually open it in a browser.
Incorrect or missing Client ID: #
- Double-check the Client ID for typos or incorrect casing.
- Confirm with your administrator if you’re unsure of your firm’s ID.
SSO login fails in the browser: #
- Ensure you are using your corporate credentials.
- If Multi-Factor Authentication (MFA) is required, complete all steps.
- Contact your internal IT or SSO administrator if login fails consistently.
Sign-in appears to succeed, but VS Code does not update: #
- Restart VS Code to ensure token refresh.
- Check for background errors in the Output panel by navigating to View > Output and selecting “Assette” from the dropdown.
Signing Out #
To end your session:
- Click Sign Out from the extension toolbar.
- This will remove your current credentials and return the extension to the login prompt.
- Signing out is useful when switching users or resetting authentication.
Security Considerations #
- Assette uses secure browser-based authentication through industry-standard SSO protocols.
- Login credentials are never stored in Visual Studio Code.
- Tokens used for session management expire automatically, reducing risk from unattended sessions.