Site Admins

Manage the team of site administrators for the platform.

API Platform Version: 8.1 and later

Table of Contents

  1. What are the components of the Site Administration section?
  2. How do I invite someone to be a Site Administrator?
  3. How do I invite non-members to be Site Administrators?
  4. How do I respond to a Site Administrator invitation?
  5. How do I cancel a Site Administrator invitation?
  6. How do I remove a Site Administrator who is assigned to the platform deployment?

What are the components of the Site Administration section?

The Administration quick filter launches the Administration section. Authorized site administrators can send out invitations to others whom they would like to invite to be site admins. All site admins have the same administration privileges for the platform deployment and can configure authentication domains that can be customized and assigned to APIs that are part of the platform deployment.

Invite Administrators

The Invite More function allows you to send invitations to individuals that you would like grant administration privileges for your API.

  • Existing administrators are displayed in a summary listing.
  • When an invitation is sent a request email is issued.
  • The invitee receives an invitation request 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

A Site Administrator can remove another Site Administrator.

Back to top

How do I invite someone to be a Site Administrator?

The Administration > Site Admins page includes an administrator invitation function that allows you to send out invitations to individuals to whom you would like to grant administration privileges for the current platform deployment.

  • During the platform installation, an initial site administration account is defined.
  • This initial administrator privilege is automatically approved and is displayed on the Administration > Site Admins page.
  • You can invite additional administrators using the Invite More function.
To invite someone to be a site admin:
  1. Log in as the Site Admin and go to the Admin section.
  2. From the left menu, choose Site Admins. The Site Admins list is displayed.
  3. Click Invite More. The Invite Administrators page displays.
  4. In the Email text box, enter the email address of individuals you would like to invite to your development team. Separate each email address with a comma.
  5. In the Add a Brief Message text box, specify the invitation text you would like to send to your invitees.
  6. Click Invite. The invitation email is sent to the invitee.

After the email invitation is sent, the platform posts an invitation notification to the member's Dashboard. To become a Site Admin, the invited user must accept the invitation on the Dashboard.

Back to top

How do I invite non-members to be Site Administrators?

If you have already received a Site Administrator invitation and are not currently a platform member, you must sign up to the platform using the email address that the invitation was issued to in order to accept the invitation. For more information, see Sign Up.

Back to top

How do I respond to a Site Administrator invitation?

If you receive an invitation via email to be a Site Administrator for the platform deployment you can accept or reject the invitation.

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

To accept a Site 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 Site Administrator invitation.
  3. Click Accept. Enter a comment if you want to, and then click Confirm.

To view a list of Site Admins, log in as the Site Admin and go to the Admin section, then choose Site Admins from the left menu. The Site Admins list displays a summary of information for each Site Admin, including username, email address, and invitation status.

Note: when you first accept the invitation, you might need to refresh the page to see the Administration icon.

To decline a Site 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 Site Administrator invitation.
  3. Click Decline. Enter a comment if you want to, and then click Confirm.

Back to top

How do I cancel a Site Administrator invitation?

Once an invitation is sent to an individual you would like to be a Site Administrator, 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 Site Administrator from the Site Admins page by clicking Remove. See How do I remove a Site Administrator who is assigned to the platform deployment?

Back to top

How do I remove a Site Administrator who is assigned to the platform deployment?

Any Site Administrator can remove other administrators from the platform deployment.

To remove someone from the Site Admin team:
  1. Log in as the Site Admin and go to the Admin section.
  2. From the left menu, choose Site Admins. The Site Admins list is displayed.
  3. On the list, find the Site Administrator that you want to remove and click Remove.

Back to top