Collaboration

When your app or service requires involvement of a team of developers, content creators, testers and so on, use the Kinvey Console collaboration features to control each member's access to the app.

You can control collaboration on app environment level or on organization level.

App Collaboration

Providing someone with access to an app involves assigning them one of the available roles. Each app environment has its own access list.

App Role Types

On app level, Kinvey collaboration operates with the following roles:

  • Owner—the individual who created the app. This person has full control over the app, including assigning roles.
  • Collaborator—provides full access over the app's resources with the exception of creating, cloning, and migrating environments. Collaborators cannot add other collaborators.
  • Administrator—similar to the Collaborator but comes with the additional ability to add collaborators.

Giving Access to an App

As an Owner or Administrator, you can invite other Kinvey account holders as either Collaborators or Administrators. Repeat the steps for each app environment that you want to provide access to.

  1. Open the app in Kinvey Console.
  2. Open the app environment that you are giving access to.
  3. In the left-hand side navigation, click Settings > Collaboration.
  4. Depending on the role of the individual that you want to add, select either Collaborators or Administrators from the tab bar on the left.
  5. In the Invite new user text field, enter the email address of the user who you want to invite.

    The email can belong to a registered Kinvey user or a new user. In both cases, the user will receive an invitation email with a link. In the latter case, however, the link will be to the Kinvey registration page instead of a direct link to the app environment.

The user will receive immediate access to your app environment.

Collaborators who haven't still created a Kinvey account are marked as pending.

Checking the Apps Collaborator Limit

Depending on the app plan, the number of contributors you can add can be limited. Take these steps to check the contributor limit:

  1. In Kinvey Console, go to the Apps view and click the app card.
  2. In the left-hand side navigation, click Manage App.
  3. Under Plan & Usage, find Contributors.

    The field indicates the number of allowed contributors or Unlimited.

Organizations

Organizations are a way to manage the development resources and user accounts available in a customer account. A typical organization contains a set of Kinvey member accounts, apps, and services.

To illustrate organization usage, assume you are a digital agency producing apps for many customers. You could create an organization for each customer and group the customer's apps under it. If most customers only have a single app, you could create an organization for each market segment to allow subject matter experts in your company to work on similar apps.

Organization Role Types

On organization level, Kinvey collaboration operates with the following roles:

  • Member—can create new apps within the organization, as well as collaborate on existing environments if invited to do so; can make use of the organization's service catalog but can't access services in other apps shared with the organization unless invited; cannot see other organization members and cannot access any of the organization's apps or environments unless explicitly invited to collaborate on them.
  • Backend Developer—provides all the privileges of a regular member, plus the abilities to create and edit service catalog items at the organization level, outside of any app, as well as access service in other apps shared with the organization. Backend developers cannot see other organization members and cannot access any of the organization's apps or environments unless explicitly invited to collaborate on them.
  • Organization Administrator—provides all the privileges of a regular member, plus the abilities to access services in other apps shared with the organization, add and remove other administrators, and view all organization members.

Sharing Apps with Organizations

Adding an app to an organization gives it the benefit of using the organization's plan as well as access to any services shared with the organization.

It is recommended to add the app to the organization while you are creating it as opposed to adding it later.

You can't remove an app from an organization after adding it. Double-check that you are adding the right app before you take any action.

To add a new app to an organization:

  1. In Kinvey Console, go to the Apps view and click Add an App.
  2. Enter a name for the app and then select the organization name from the Organization drop-down list.
  3. Click Create App.

To add an existing app to an organization:

  1. In Kinvey Console, go to the Apps view and click the app card.
  2. In the left-hand side navigation, click Manage App.
  3. Under Organization, select the organization name from the drop-down list.
  4. Click Add to Organization.

In both cases, you will see the organization name indicated on the app card if you return to the Apps view.

App in Organization

Will the app plan change after adding the app to an organization?

If you add an existing app to an organization, it will not upgrade its plan even if the organization's plan is higher. Ask your Instance Admin or Kinvey Admin to upgrade the plan for you.

When you add an app to an organization during the app creation, it is automatically assigned the organization's plan.

Sharing Services with Organizations

Adding a service to an organization makes it accessible to all apps in that organization. This way a single Kinvey user, such as a network administrator, can configure a service once and provide it to everyone to use. This approach also increases security as you can apply better control over who maintains a service in an organization.

Services that can benefit from being shared in an organization include a MIC service to the company's Active Directory, a RapidData service to an SQL server, or a Flex service running frequently utilized server-side code for code reuse between apps.

To add a service to an organization:

  1. In Kinvey Console, go to the Services view and click Add a Service.
  2. Choose the service type.
  3. On the Configure service settings screen where you give the service a name, select Organization for Scope.
  4. Select the organization name from the drop-down list that appears.
  5. Click Save.

Services shared with organization that you belong to appear in the Services view similarly to services set up by you.

Viewing Apps and Services Shared with Organizations

As soon as an app is added to an organization, it is immediately visible in the Organization Settings view by eligible organization roles. However, for the app to become visible to ordinary members, they need to be added as collaborators to each separate app. When that is done, apps appear in each member's Apps view.

As soon as a service is added to an organization, it becomes immediately visible to all organization members and their apps. Members can see shared services both in the Services view and in the Organization Settings view.

Managing Organization Members

As an organization administrator, you have the ability to invite users to the organization, as well as to revoke their access and determine their organization role.

To manage organization members:

  1. In Kinvey Console, click the Organization settings icon in the top navigation bar.
  2. Select the organization from the list on the left.
  3. In the main pane, select the Members tab.
  4. Take any of the following action:

    • To invite a user, click Invite a User to get an invitation link. After the user has clicked the link, you will be able to approve their membership.
    • To approve a user, select their entry in the list and click Approve User in the sidebar.
    • To remove a user from the organization, click Revoke User Approval.
    • To give the user a role, click the respective buttons under Membership, Backend Developer, or Organization administrator. A single user can have multiple roles.

Removing Apps and Services from Organizations

Once added, apps and services cannot be removed from an organization. You can, however, delete an app or a service and recreate if outside of the organization.

Organization Settings

As an organization administrator, you have the ability to alter its settings. Settings include security-related settings like requiring email verification and administrator approval as well as the ability to rename and delete the organization.

To change organization settings:

  1. In Kinvey Console, click the Organization settings icon in the top navigation bar.
  2. Select the organization from the list on the left.
  3. In the main pane, select the Settings tab.