Workspace icon

Workspace

Get and change data from Workspace API
Join our community

Actions22

Overview

The node named "Workspace" integrates with the Workspace API to manage various resources, including users. Specifically, for the User resource and the Create User operation, this node allows you to create a new user in the Workspace system by providing user details such as name, email, company, role, and other relevant fields.

This node is beneficial in scenarios where you want to automate user onboarding processes, synchronize user data from other systems, or programmatically manage user accounts within the Workspace platform. For example, when a new employee joins a company, you can use this node to automatically create their user account with all necessary details and permissions.

Properties

Name Meaning
First Name First name of the user
Last Name Last name of the user (required)
Email Email address of the user (required)
Company Company name associated with the user
Department Department the user belongs to
Role Global role assignment for the user; if not provided, the default tenant role will be used
Password Password for the user account
Email Notifications Enable or disable email notifications; defaults to false
Entra ID Microsoft Entra ID (formerly Azure AD) identifier for the user

These properties are grouped under a collection named "Create User" and correspond to the fields sent in the request body when creating a user via the Workspace API.

Output

The node outputs JSON data representing the newly created user object returned by the Workspace API. This typically includes all user details such as user ID, names, email, roles, and any metadata assigned by the system.

If the API supports it, the output may also include status information about the creation process or error messages if the creation failed.

There is no indication that this node outputs binary data.

Dependencies

  • Requires an active connection to the Workspace API.
  • Needs an API key credential and tenant identification configured in n8n credentials.
  • The node sends requests with headers including Accept: application/json, Content-Type: application/json, and authentication headers (APIKEY and TENANT).
  • Base URL for the API is configurable via credentials.

Troubleshooting

  • Missing Required Fields: If "Last Name" or "Email" are not provided, the API may reject the request. Ensure these required fields are filled.
  • Authentication Errors: Invalid or missing API key or tenant information will cause authentication failures. Verify credentials are correctly set up.
  • Invalid Role: Providing a role that does not exist or is not permitted may result in errors. Use valid role values or omit to use the default.
  • Network Issues: Connectivity problems to the Workspace API endpoint will prevent user creation.
  • Password Policy: If the password does not meet the Workspace API's security requirements, the creation might fail.

Error messages from the API should be reviewed to identify specific issues, and adjusting input parameters accordingly usually resolves them.

Links and References

Discussion