API Admin Management

Invite others to be API Admins for your API and manage the API Admin group.

API Platform Version: 8.1 and later

Table of Contents

  1. What are the components of the Admin page?
  2. How do I invite people to be administrators for my API?
  3. How do I invite non-members to be administrators of my API?
  4. How do I respond to an API administrator invitation?
  5. How do I cancel an API administrator invitation?
  6. How do I remove an API administrator from my API?
  7. Related Topics

What are the components of the Admin page?

The APIs section includes an Admins page that allows you to invite others to be administrators for your API. API administrators can then be viewed and managed in a summary listing.

Invite Administrators

The Invite More function allows you to invite additional users to be administrators for your API.

  • Existing administrators are displayed in a summary listing.
  • When an invitation is sent the invitee receives an email notification as well as an invitation on their Dashboard page. If the invitee is not a platform member, they must sign up using the same email address that the invitation is addressed to in order to accept the invitation via their Dashboard.
  • While an invitation is still pending, a Resend Email button is available so you can remind the invitee.
  • At any point after a member has been invited, a Remove button is available so that you can remove the invitee or team member.

View Administrators

When an administrator invitation is submitted, a new entry is added to the list with the username, email address, and an initial invitation status of Pending.

Manage Administrators

API Administrators can remove an Administrator from the listing.

Back to top

How do I invite people to be administrators for my API?

The My APIs > API > Admins page includes an administrator invitation function that allows you to invite people to be administrators for your API.

  • When you create an API, you are the first administrator.
  • Your administrator privilege is automatically approved.
  • You can invite additional administrators using the Invite More function.
To invite someone to be an API Admin:
  1. Navigate to My APIs > API name > Admins. The Admins page displays.
  2. Click Invite More. The Invite Administrators page displays.
  3. In the Email text box, enter the email address of individuals that you want to invite to your development team. Separate multiple email addresses with commas.
  4. In the Add a Brief Message text box, specify the invitation text that you want to send to your invitees.
  5. Click Invite. The invitation email is sent to the invitee.
  6. After the email invitation is sent, the platform will post an administrator invitation to the member's Dashboard. The invited member can then log into the platform to accept or decline the administrator invitation.

Note: When you create an API, you are the administrator. Your administrator privilege is automatically approved and is posted to the Admins Summary page. You can then invite additional administrators using the Invite More function. Invitees that are not platform members must sign up before accepting the team invitation.

Back to top

How do I invite non-members to be administrators of my API?

You can invite non-members to be administrator of an API, but in order for the invitee to accept the invitation, they must be platform members. See Basics for sign up information.

Back to top

How do I respond to an API administrator invitation?

If you receive an invitation via email to be an administrator of an API you can accept or reject the invitation.

Note: You must be a platform member to join a development team. If you have already received a development team invitation and are not currently a platform member, you must sign up to the platform using the email address that the team invitation was issued to in order to accept the invitation. If you are not currently a member, see Basics for sign up information.

To accept an API administrator invitation:
  1. Log in to the platform (you can click the link in the invitation email) and go to your Dashboard page.
  2. Find the API administrator invitation.
  3. Click Accept. Enter a comment if you want to, and then click Confirm.

To view administrators for the API, click My APIs, choose the API, and then click Admins. The Admins page displays a summary of information for each API Admin, including username, email address, and invitation status.

To decline an API administrator invitation:
  1. Log in to the platform (you can click the link in the invitation email) and go to your Dashboard page.
  2. Find the API administrator invitation.
  3. Click Decline. Enter a comment if you want to, and then click Confirm.

Back to top

How do I cancel an API administrator invitation?

Once an invitation to be an API administrator is sent out, the invitation itself cannot be revoked. A platform member can choose to accept or decline the invitation. If they choose to accept the invitation, you can remove the API administrator from your API by clicking Remove. See How do I remove an API administrator from my API?

Back to top

How do I remove an API administrator from my API?

Any API administrator can remove other administrators from the API.

To remove someone from the API admin team:
  1. Navigate to My APIs > API Name > Admins. The Admins page displays.
  2. To remove an API administrator from an API, choose the line item of the API administrator and click Remove.

Back to top