Step 9—Manage teams and users

This topic describes how AMPLIFY platform and API Central Service administrators can manage AMPLIFY platform users and API Central Service teams. It also shows how to use teams to manage access to apps, APIs, API products, and runtime groups.

Create an API Central Service team

API Central Service administrators can create new teams for users (for example, API developers or application developers):

  1. Click Registry > Teams in the menu on the left.
  2. Click the + Team button at the top right.
  3. Enter a required team name. The description, phone, email, and tags are optional.
  4. Under Select Runtime Access, select the API Central Service runtime groups that the team can access to deploy their API proxies (for example, sample test and production runtime groups are currently supported).
  5. Click Save at the top right.
  6. Click Add users, apps to this team to update team membership and access details. Alternatively, click Skip this, and go back to Teams list.

To delete a team in the list, click the garbage icon on the right, and click Delete team.

Add users to the team

Note   An API Central Service administrator must first add a new user to an AMPLIFY platform organization before you can add them to an API Central Service team.

For more details, see the following:

View the team access to apps

Team members can view only the client apps that their team has access to. To view the apps that the team can access:

  1. Click Registry > Teams in the menu on the left, and click a team in the list.
  2. Click the Apps tab to display the apps that the team can access.
Note   If the app list is empty, this means that no apps have been created for this team yet.

Create an app for the team

To create an app for this team:

  1. Click Apps in the navigation menu on the left, and click + App at the top right.
  2. Enter the app details (name and team are required). Selecting a team enables all the users in the team to access the app.

For more details, see Step 5—Create client apps for API access.

Grant the team access to APIs

Team members can view only the API proxies that their team has access to. To grant the team access to API proxies:

  1. Click Registry > Teams in the menu on the left, and click a team in the list.
  2. Click the APIs tab, and click + API on the right.
  3. Select the APIs that you wish to grant access to, and click Add APIs.

To delete an API in the list, click Remove on the right.

Grant the team access to API products

Team members can only view the API products that their team has access to. To grant the team access to API products:

  1. Click Registry > Teams in the menu on the left, and click a team in the list.
  2. Click the API Products tab, and click + API Product on the right.
  3. Select the API products that you wish to grant access to, and click Add API products.

To remove an API product from the list, click Remove on the right.

Grant the team access to runtime groups

Team members can only view the runtime groups that their team has access to. To grant the team access to runtime groups:

  1. Click Registry > Teams in the menu on the left, and click a team in the list.
  2. Click the Runtime groups tab, and click + Runtime on the right.
  3. Select the runtime groups that you wish to grant access to, and click Add Runtimes.

For more details, see Step 3—Deploy the API proxy to runtime groups.

To remove a runtime group from the list, click Remove on the right.

Add an AMPLIFY platform user to your organization

AMPLIFY platform administrators must add new users to a platform organization before API Central Service administrators can add them to an API Central Service team. The free subscription user has both AMPLIFY platform administrator and API Central Service administrator privileges and can do this as follows:

  1. Click the drop-down icon in your AMPLIFY platform profile at the top right, and select Organization. For example:
  2. Click Members in the navigation bar on the left.
  3. Click + at the top right to add a new user.
  4. Specify the following user details only:
    • Email address
    • Role (Administrator or Developer)
  5. Click Add Org Member.

This sends an email to the new user with a link to activate their AMPLIFY platform account.

Add AMPLIFY platform users to API Central Service teams

When you have added a new AMPLIFY platform user to your organization, and this user logs into their AMPLIFY platform account and selects API Central Service, they are automatically added to the default API Central Service team with an API developer role.

You can then add this user to other API Central Service teams and assign the required user roles:

  1. Select API Central Service from the AMPLIFY platform navigation bar.
  2. Click Registry > Users in the menu on the left.
  3. Select a user, click the Teams tab, and click Add user to teams on the right.
  4. Select the teams for which the user is a member, and select a role for each team:
    • API Developer
    • API Product Manager
    • API Tester
    • Application Developer
  5. Click Add Teams.
Note   To edit a user role, you must remove the user from the team and add them again with a different role.

Alternatively, you can also select a team and add users as follows.

  1. Click Registry > Teams in the menu on the left.
  2. Select a team, and click Add Users on the right.
  3. Select the users that you wish to add to the team, and select a role for each user.
  4. Click Add Users.
Tip   For detailed information on the permissions associated with each user role, select Registry > Roles, and select a role (for example, API Developer).

For details on creating teams, see Create an API Central Service team.

Example: onboarding AMPLIFY platform users to API Central Service

Bob is an AMPLIFY platform administrator and API Central Service administrator in Acme Corporation, which has a dedicated environment provisioned in API Central Service. Joe also works for Acme Corporation as a developer in the AMPLIFY platform.

The process to give Joe access to API Central Service is as follows:

  • Joe clicks API Central Service in the AMPLIFY platform navigation bar (see Sign up for an AMPLIFY platform account).
  • Joe is onboarded to the API Central Service instance for Acme Corporation.
  • Joe is automatically assigned to the default API Central Service team with an API developer role, and can create API proxies, deploy them to test and production runtimes, create an application, and so on.

When this is complete, Bob can add Joe to different API Central Service teams with the appropriate user roles for those teams (for example, API developer, API tester, application developer, and so on).

Note   Bob can only add users to teams who have actively requested access to API Central Service. API Central Service does not have access to all Acme Corporation users in the AMPLIFY platform.

Related topics

API Central Service concepts

Related Links