Configure team management

The Apigee submodule Apigee Teams enables app developers to create teams and collaborate on apps, as described in Manage teams of app developers. The Apigee Teams submodule is supported for Apigee Edge, Apigee X, and hybrid organizations.

Note: This module uses Company APIs, if you are creating Teams in Apigee Edge organization, but will use AppGroups APIs if you are connected to a Apigee X organization.

To enable Apigee Teams in your developer portal:

1. Select Extend in the Drupal administration menu.
2. Enable the Apigee Teams module.
3. Click Install.

Once the module is installed, you can configure the team management process, as described in the following sections:

• Create team roles
• Configure permissions for roles
• Create and manage team invitations
• Manage roles for team members
• Manage the fields displayed when viewing a team

Note: In addition, you can configure the following:

• The alias that is used to refer to teams in the developer portal, as described in Configure aliases.
• Caching of specific team data, as described in Configure caching.

Create team roles

Create one or more roles to be globally available for each team.  Team administrators can then set one of the globally defined roles for each team member.

Note:  The "member" role will be granted to all team members automatically.  As a result, this role can be used to configure default permissions for roles.

To create a Team role:

1. Select Configuration > Apigee > Teams.
2. Click the Roles tab.
3. Click Add role to add a new role.
4. Complete the form.
5. Click Save.

Configure permissions for roles

Configure the permissions that are enabled for each role you created. By default, all newly created roles will have "member" role permissions enabled.  If you want to remove a permission enabled by default in a newly created role, you must first remove that permission from the "member" role.

To configure additional Team permissions for roles:

1. Select Configuration > Apigee > Teams.
2. Click the Permissions tab.
3. Configure the permissions, as required, to enable team members to:
   • Add or remove other team members
   • Create, edit, delete or view analytics for team apps
   • View and assign public, private, or internal API products to team apps
   • Manage or accept team invitations.
4. Click Save configuration.

To configure additional Global permissions, select People > Permissions.

Create and manage team invitations

The team invitation feature can be used to customize invitation emails, invite users to a team, and manage team invitations once sent.  In order to utilize this feature, confirm that the appropriate global and team permissions are configured correctly, as shown in the table below.

Configure team invitations

To configure team invitations to send to users:

1. Select Configuration > Apigee > Teams.
2. Click the Team invitation tab.
3. Enter the desired number of days before invitations expire into the "Expiry days" field.
   • To handle team invitation expiration, you need a configured cron maintenance task.
   • See Configuring Cron for more information.
4. Configure the email subject and body of the team invitation. There are two email templates available; one for existing users and one for new users.
5. Click Save configuration.

Invite users to a team

Any user with the Global "Manage team members" permission or the Team "Manage team members and invitations" permission can invite users to a team.

1. Select Teams in the top navigation of your application.
2. Click the name of the team to view the team details.
3. Click the Members tab to view the team members.
4. Click the Invite members button.
   • Fill in the user email addresses, separated by commas.
   • Select the roles for each member.
5. Click Invite members.

Manage team invitations

From the Members tab, you can find a list of all current and invited team members, including pending invitations.  

Resend team invitation

To resend an invitation email, locate the invitation recipient under Pending Invitations and click Resend.

Revoke team invitation

To revoke a team invitation, locate the invitation recipient under Pending Invitations and select Revoke from the Operations  drop-down.

View invitations as a user

To view invitations sent to your user account, select My account > Invitations.

Manage roles for team members

To add roles or change global roles assigned to team members:

1. Select Teams in the top nav bar of your application.
2. Click the name of the team to view details.
3. Click the Members tab to view members and their roles.
4. Click Edit to add or modify team roles for a member.
5. Click Save.

Manage the fields displayed when viewing a team

View team details by clicking its name on the Teams page.

Manage the fields displayed when viewing team details by selecting Configuration > Apigee > Teams to display the Teams configuration page and clicking the Manage display tab.

To manage the details, configure the following settings for each field, and click Save.

Configure Channel ID for your portal

The channel ID set in the configuration, filters the list of AppGroups returned by the module.

To configure AppGroup channelId filter:

1. Select Configuration > Apigee > Teams.
2. Click the Settings tab.
3. Enter the desired channel Id into the "ChannelID" field.
   • While creating new AppGroup, the configured ChannelID will be set for an AppGroup.
   • If the Channel ID field is empty, the default "devportal" as channel ID will be set for an AppGroup.
4. Enable the "Filter by Channel ID" checkbox to filter the AppGroup based on Channel ID.
5. Click Save configuration.