Squidex
  • Welcome to Squidex
  • Getting Started
    • Squidex Cloud
    • Installation Instructions
      • Platforms
        • Install on Kubernetes
        • Install on AWS (Deprecated)
        • Install on AWS EC2 using Docker
        • Install on Azure
        • Install on Azure using ARM
        • Install on Google Cloud Platform (GCP)
        • Install on Docker
        • Install on Heroku
        • Install on IIS
        • Install on Render
        • Install on Vultr
      • Configuration
        • Deploying the Image Resizer Service
      • Troubleshooting and Support
        • Diagnose Runtime Issues
        • Restoring Deleted Apps
      • Install Identity (Deprecated)
      • External Identity Providers
        • Azure AD (OAuth) with Squidex
    • Contributing and Developing
      • Building
      • Developing
      • Extensions
        • Custom Rule Action
      • Contributing
      • Architecture
      • Translating
      • Squidex Docs Program
    • Roadmap
    • Quick Start Guides
      • Vue.js Blog with Squidex
      • React.js Blog with Squidex
      • Angular Blog with Squidex
  • Documentation
    • Introduction and Use Case
    • Concepts
      • Apps
      • Teams
      • Schemas
        • Field Rules
      • Content
        • Scheduled Publishing
      • Assets
        • Querying Assets
      • Localization
      • Migrations
      • Roles & Permissions
      • Rules
        • Publish an Event to Azure Queues using Rules
        • Populate Elasticsearch Index
      • Backups
      • Subscriptions
        • App Subscriptions v/s Team Subscriptions
      • Notifications
      • Dashboard
      • Workflows
    • Software Development Kits
      • TypeScript
      • .NET
        • Version v14 (and Earlier)
        • Version v15 (and Later)
      • PHP
      • Java
    • Developer Guides
      • API
        • Authentication
        • Postman
        • Queries
        • Assets
      • Automation Tools (CLI)
      • Scripting
        • Scripting Helper Methods
      • Embed Content
      • Custom Workflows
      • Custom Editors
      • Custom Sidebars
      • Preview Content
      • Rule Formatting
        • Simple
        • Script
        • Liquid
      • Tutorials
        • Building a Blog with Squidex and Next.js
  • Next
    • Squidex 3.0: API Compatibility
Powered by GitBook
On this page
  • Creating a Team
  • Managing Subscriptions
  • Transferring an App to a Team
  • Managing Quota (for Multiple Apps)
  • Team Dashboard
  • Deleting a Team
  • Other Important Information About Teams

Was this helpful?

  1. Documentation
  2. Concepts

Teams

A Team is Used to Group Apps for Sharing a Subscription and for Easier Management

PreviousAppsNextSchemas

Last updated 2 years ago

Was this helpful?

This documentation is based on the FoodCrunch use case. Please open the link below alongside this page to understand the examples.

Teams are primarily beneficial for the Squidex Cloud where an organization has multiple Apps and wishes to share the subscription.

The Teams capability solves the following problems:

  • Generally, subscriptions are associated with the single user who creates it. So, in a situation where this it must be transferred to another user, it can be inconvenient.

  • Since subscriptions are bound to a single App, it cannot be shared among multiple Apps for scenarios such as grouping and distributing the cost amongst Apps.

Creating a Team

To create a team, click Apps and Team (1) and click Create Team (2).

Next, enter a Name (3) for the team and click Create (4).

Managing Subscriptions

In order to manage subscriptions for a team, navigate to Settings (1) and then click Subscription (2).

A subscription is shared among all Apps in the team.

Transferring an App to a Team

Once a team is created, you can move an App to the team. To do so, navigate to the App, click Settings (1) and then more Settings (2). Then, select the team from the dropdown under Transfer to team (3) and click Transfer (4).

Only when a user has permissions for the App and the team, can they transfer the App to the team.

At this point, you won't see a confirmation or the screen won't change. A way to verify that the App has moved to a team is to check in your Welcome dashboard or on the Team dashboard.

In this example, we moved the FoodCrunch App to the FoodCrunch team.

Once an App has moved to a team, the subscription for the App can only be managed by the team.

Managing Quota (for Multiple Apps)

As a Subscription is shared among all Apps that are part of the team, the quota for a subscription is also shared.

If you wish to limit API calls for certain Apps (e.g. to protect your API contingent for other Apps that are more important), you can set the Max API Calls parameter for each client in an App.

Team Dashboard

Every team has a dashboard similar to an App and displays the same statistics, including the Apps associated with the team.

Deleting a Team

At the moment a team cannot be deleted.

Other Important Information About Teams

  • You can add contributors to a team but there is no provision for roles at the moment.

  • A team contributor can only manage the subscription of the team and does not have automatic access to associated Apps.

Introduction and Use Case
Creating a Team - Step 1
Creating a Team - Step 2
Managing subscription
Transferring an app to a team
App part of a team
Subscription management of app
Setting API limits for clients
Team Dashboard