This is an old documentation. Go to the latest Customer's Canvas docs

setUserId Method


  • setUserId(userId: string ) : Promise < void >
  • Sets a new user identifier and moves user files to this user's folders.

    Before using this method, you must enable the secure mode and update an authentication token by using the additionalUserId parameter with the new user identifier.

        <title>Setting a new user ID</title>
        <!-- The IFrame API script. IMPORTANT! Do not remove or change the ID. -->
        <script id="CcIframeApiScript" type="text/javascript" src="">
        <!-- The iframe to display the editor in. -->
        <iframe id="editorFrame" width="100%" height="800px"></iframe>
        <input type="button" value="Set User ID" onclick="setUserID()" />
            var editor = null;
            document.addEventListener('DOMContentLoaded', async () => {
                // Initialize product with an Invitation template.
                const productDefinition = { surfaces: ["invitation"] };
                // Get the iframe element to display the editor in.
                const iframe = document.getElementById("editorFrame");
                // Load the editor.
                editor = await CustomersCanvas.IframeApi.loadEditor(iframe, productDefinition)
                    // If there was an error thrown when loading the editor.
                    .catch(e => console.log(e));
            // Set JohnWood as a new user ID.
            async function setUserID() {
                var userId = await editor.configuration.getUserId();
                // Get an active token for the current user.
                var token = (await (await fetch("" + userId + "/Tokens",
                        method: "GET",
                        headers: { "X-CustomersCanvasAPIKey": "UniqueSecurityKey" }
                // Update the token for another user.
                await fetch("" + token + "?AdditionalUserId=JohnWood", {
                    method: "PUT",
                    headers: { "X-CustomersCanvasAPIKey": "UniqueSecurityKey" }
                // Copy user files.
                    .catch(e => console.log(e));


    • userId: string

      The new user identifier that needs to be set for the product.

    Returns Promise < void >