SHARE THIS ARTICLE

Teams

Teams allow an easy way to share and collaborate on API definitions.

Members of a team can share their API descriptions with each other. The subscription of the team owner is shared among all team members.

Note   The users who are members of a team are not charged for their subscriptions and are reverted back to their old plan if they leave the team.

Note   SDKs generated are recorded against the team owner’s subscription.

Creating your team

  1. Click on Create Team under the Settings sidebar in the Account Section. You will be taken to the following page: Create Team
  2. Click on Create Team button. This will create the team and redirect you to the team management page. From this page, you can add/remove members. Create Team

Adding a new member

New members can be added to your team by simply entering their email address in the Manage Team page. Click on Invite once you have entered the email address, to send the email invitation.

Add member

As shown below, the member is now added as pending.

Invite member

The user will have received an invitation on his email like the one shown below. He needs to accept this in order to view any shared APIs.

Invite member

Once he accepts the invitation, he will be shown some terms:

Invite member

After accepting these, he will successfully become a member of the team.

Invite member

Removing a member

You can remove a team member anytime from your Manage Team page. Just click on the cross next to the member’s name in the teams list.

Remove member

You will be asked to confirm if you really want to proceed with removing the member. Click on Remove and the team member will be removed.

Remove member

Sharing an API

A team member is able to share their APIs they own. They can also apply read-only permission to prevent other team members from editing the definition.

Navigate to My APIs page. Click on + of an API entity to share this API with your team.

Share API

You will be displayed with the list of team members with whom you can share your API. You can enable/disable write access to any of the member by toggling the Write Access button.

Just click on Share infront of the team member name and the API will be shared with that user.

Share API

Once the API has been shared, you will see the team member logo displayed on your API Entity.

Share API

This shared API will become visible in the team member’s My APIs page

Share API

To unshare the API with this team member, you can click on UnShare infront of the member’s name within the Share API dialog box.

Share API

Leave the Team

You can choose to leave the team of which you are the member. To do this, navigate to your View Team page.

Under the list of team members, you will see a Leave Team button. Click on it.

Leave Team

Click on Confirm and you will no longer remain part of the team.

Confirm Leave

Delete the Team

If you are the owner of a team, you can delete this team anytime. Navigate to the Manage Team page. Below the list of members, you can see the Delete Team button. Click on it.

Delete Team

Click on Confirm and the team will be successfully deleted.

Confirm Delete


Have questions? Submit a request.