The Workspace Management and Settings page allows you to view and update key configuration details for each workspace. Here, you can manage the workspace URL, description, team access, authentication settings, variables, and see a list of all endpoints associated with the workspace.
Workspace Management and Settings
Configurable Workspace Settings
1. URL
The workspace URL is automatically generated based on the workspace name, but you can customize it here if necessary. This URL is the base path used to access endpoints within this workspace.
To update the URL: Enter the new URL in the designated field and save your changes.
2. Description
The description field allows you to add context or notes about the workspace's purpose or specific functionality. This can be useful for other team members or when managing multiple workspaces.
To update the description: Edit the text in the description field and save your changes.
3. Team Access
Each workspace can be assigned to a team responsible for managing its functions and endpoints. Only members of the assigned team will have access to make changes or add functions within this workspace.
To update team access: Select a new team from the dropdown menu and save the changes to reassign the workspace.
4. Authentication Settings
FaasPlus provides multiple authentication methods to control access to endpoints within the workspace:
- NONE: No authentication is required. Use this for public or test endpoints.
- IP BASED: Restrict access based on specific IP addresses or ranges.
- BASIC: Requires a username and password for access, adding a simple layer of security.
- API_KEY: Requires an API key for secure access, recommended for production endpoints.
To update authentication: Choose your preferred method from the authentication options and save your changes. The selected method will apply to all endpoints within this workspace.
5. Workspace Variables
Workspace variables store frequently used values, such as hostnames or configuration parameters, which can be referenced by endpoints within the workspace. Examples include API keys, remote URLs, or static settings.
To add or update variables: Enter key-value pairs for each variable, then save the changes. These variables can be accessed within endpoint configurations to maintain consistency and simplify updates.
6. Associated Endpoints
The workspace settings page provides a list of all endpoints that belong to this workspace, making it easy to manage and monitor your endpoints in one place. Each entry includes the endpoint name, method (e.g., GET, POST), and status.
To view or edit an endpoint: Click on the endpoint’s name to navigate to its specific configuration page, where you can update its settings or view detailed logs.
Summary
The Workspace Management and Settings page is your central hub for configuring and controlling each workspace. By updating the URL, description, team access, authentication, and variables, you can maintain secure and organized workspaces, optimized for your project’s specific needs. Additionally, with a list of all associated endpoints, you can quickly navigate between configurations to manage your functions efficiently.