Groups

Create and manage groups in the developer portal.

API Platform Version: 8.1 and later

Table of Contents

About Groups:
  1. What is a group?
  2. What are the different types of groups on the platform?
  3. What are the group membership roles?
  4. What can a group Member do?
  5. What can a group Leader do?
  6. What can a group Admin do?
  7. How do I make someone a group Leader?
  8. How do I make someone a group Admin?
  9. How does group visibility work?
Managing Groups:
  1. How do I add a group?
  2. What are the components of the Group Details page?
  3. How do I access a group?
  4. How do I invite someone to a group?
  5. Can I invite non-members to a group?
  6. How do I accept an invitation to a group?
  7. How do I decline an invitation to a group?
  8. How do I edit group information?
  9. How do I remove a group member?
  10. How do I re-send a group member invitation?
  11. How do I delete a group?
  12. Why can't I add a group?
API Scope Groups:
  1. What is an API Scope Group?
  2. How do I add an API Scope Group?
  3. What are the components of the API > Visibility > Groups page?
  4. How do I access an API Scope Group?
  5. How do I delete an API Scope Group?
Group Ratings and Reviews:
  1. Where can I find rating and review information for each group?
  2. How do I rate a group?
  3. How do I review a group?
  4. How do I edit a group review?
  5. How do I delete a group review?

About Groups:

What is a group?

On the platform, you can create a special-interest group of any time, and invite people to it. Creating a group enables collaboration between group members.

Groups have three levels of membership:

  • Admin
  • Leader
  • Member

The person who creates the group becomes the first Admin, and can invite additional members to the group, as well as changing the role of an existing member. Groups can also be invited to have visibility of APIs; in this scenario, every member of the group has visibility, without having to request a contract with the API.

When a user is first invited to the group, on accepting the invitation, the user becomes a Member. From there, the member can be promoted to a Leader or Admin role.

All group members can:

  • Collaborate on the group Forum. Depending on the visibility setting, the Forum is visible only to group members or to all platform users.
  • See summary information about the group, on the Group Details page. See What are the components of the Group Details page?
  • Provide feedback on the group by providing a review or rating. See Group Ratings and Reviews.
  • Have visibility of any APIs that the group has been invited to have visibility of.

Back to top

What are the different types of groups on the platform?

There are three variations of the standard platform group with the three-tier membership (Admin, Leader, and Member):

  • Standalone (independent) group, created from the top menu bar: see How do I add a group?
  • API Scope Group: a group that's created in the context of a specific API, if the develop portal is configured to support this feature. There are two types of API Scope Group:
    • Independently Managed: the group can exist separately from the API; if the API is deleted, the group is not deleted.
    • Not Independently Managed: the group exists solely in the context of the API; if the API is deleted, the group is automatically deleted also.

    For more information, see API Scope Groups.

The platform also supports different types of group with a specific role, such as developers for a specific app, API Admins for a specific API, Business Admins, and Site Admins. These groups only have one membership level.

Back to top

What are the group membership roles?

Groups have three levels of membership:

Back to top

What can a group Member do?

When a user accepts a group membership invitation, the user initially has the status of Member.

Group Member capabilities

Users with Member status and above have access to the following functions:

  • Details (see What are the components of the Group Details page?)
    • View information about the group.
    • Give the group a rating.
    • Write a review of the group.
    • Follow the group.
  • Forum:
    • Add or view forum entries, including Discussions, Tickets, Alerts, or Requests.
    • Vote on forum entries.
    • Comment on forum entries.
    • Vote on forum entry comments.
    • Follow or unfollow the forum.
  • Members: View a list of members and leaders, and their status
  • Admins: View a list of Admins, and their status
  • Followers: View a list of users who are following the group.

Back to top

What can a group Leader do?

Once a user accepts the group membership invitation, a group Leader or Admin can make that member a Leader. The Leader has all the same capabilities as a group Member, as well as some additional functions, as shown below.

Group Leader capabilities

Users with Leader status have the following additional capabilities:

  • Members:
    • Invite new members. See How do I invite someone to a group?
    • Change someone's membership status from Member to Leader
    • Change someone's membership status from Leader to Member

Back to top

What can a group Admin do?

When a user creates a group, that user becomes the first Admin, and has visibility of various functions associated with the group.

The Group Admin can perform all functions relating to the group.

Group Admin capabilities

Users with Admin status can perform all the functions of Members and Leaders, and have the following additional permissions:

Back to top

How do I make someone a group Leader?

A group Leader can perform more functions than a general member, including inviting members. For details, see What can a Group Leader do?

To assign or unassign the Leader role:

To complete these steps, you must be an Admin or Leader for the group.

  1. Go to the Groups page. See How do I access a group?
  2. Click the name of the group. The Group Details page displays.
  3. In the left navigation bar, click Members. The Members page displays a list of group members with the Member or Leader role. In the example below, one person is a Leader and one has been invited but has yet accepted the invitation.

    Assign member role

  4. Click the button to assign the new role:
    • A Leader can click Make Leader.
    • An Admin can also choose Make Admin, as shown above.
  5. At the Change Role confirmation message, click OK.

Back to top

How do I make someone a group Admin?

A group Admin has full rights to perform all functions for the group. For details, see Group Admin Capabilities.

To assign or unassign the Group Admin role:

To complete these steps, you must be an Admin for the group.

  1. Go to the Groups page. See How do I access a group?
  2. Click the name of the group. The Group Details page displays.
  3. In the left navigation bar, click Members.
  4. Find the user on the list, and click Make Admin.
  5. At the Change Role confirmation message, click OK.
To unassign the Group Admin role:
  1. Go to the Groups page. See How do I access a group?
  2. Click the name of the group. The Group Details page displays.
  3. In the left navigation bar, click Admins.
  4. Find the user on the list, and click Make Member or Make Leader. An example is shown below.

    Group Admins page

  5. At the Change Role confirmation message, click OK.

Back to top

How does group visibility work?

When you create a group, you can control who will be able to see the group in the platform, via the Visibility setting.

In the Add a New Group or Edit Group Info page, there are three visibility options:

  • Public: Visible to all users, even users who are not logged in.
  • Private: Visible only to group members.
  • Registered Users: Visible to all users who are logged in to the platform, even when they are not group members.

Back to top

Managing Groups:

How do I add a group?

You can add a group from the top menu bar, as shown below.

Hermosa Theme: Default Theme:
Adding a group, Hermosa theme Adding a group, Default theme

Note: In some cases, depending on platform settings, the option to add a new group might not be available.

To add a group:
  1. In the top navigation bar, choose Add Group.
  2. In the Start Your New Group page, enter information about the group:
    • Group Name: A brief descriptive name.
    • Group Description: Short descriptive summary about the group.
    • Tags: one or more key words that people can use to search for the group.
    • Visibility: Determines who can see the group. For details, see How does group visibility work?
  3. In the Group Icon section, you can upload an icon for your group. See How do I upload and crop icons?
  4. Click Save.

Back to top

What are the components of the Group Details page?

The Group Details page shows summary information about the group.

To access: follow the instructions in How do I access a group? below.

An example is shown below.

Group Details page

It includes information such as:

  • Group name, description, tags, and avatar
  • Creation date
  • The group's privacy setting
  • Number of Members and Admins
  • Information about ratings and reviews

From here you can:

  • Follow a group (button top right)
  • View the group Forum. An example is shown below.

    Group Forum

  • View and manage group Members and Leaders. An example is shown below.

    Group Members and Leaders page

  • View and manage group Admins. An example is shown below.

    Group Admins page

  • View and manage group Followers.

Back to top

How do I access a group?

In the developer portal, in the top navigation bar, click Groups, as shown below.

Hermosa Theme: Default Theme:
Groups menu, Hermosa theme Groups menu, Default theme

The Groups list page appears, showing the groups you're a member of. Find the group you want, and click the title to go to the Details page for the group. An example is shown below.

Groups list page

Back to top

How do I invite someone to a group?

If you have the group Leader role, you can invite others to the group. If you want to invite others but you're not a Leader, you can request a role change by submitting a ticket to the Admin via the group Forum.

Note: If you invite someone who hasn't yet signed up for the developer portal, they'll have to sign up before accepting your invitation to the group. They'll receive instructions in the invitation email.

To invite someone to a group:
  1. Go to the Groups page. See How do I access a group?
  2. Click the name of the group. The Group Details page displays.
  3. Choose the applicable left menu option:
    • To invite someone to be a member, click Members.
    • To invite someone to be an admin, click Admins.
  4. Click Invite More.
  5. In the Invite Group Members or Invite Administrators box, enter one or more email addresses. Use a comma separator between multiple email addresses.
  6. Add a brief message. Your message will be included in the invitation email.
  7. Click Invite.

An invitation email is sent out to each invitee, with a link to accept the group invitation. Invitees must log in to the developer portal to accept the invitation.

Once an invitee has accepted the group invitation, you can change the group member role to Admin or Leader, if you're an Admin or Leader yourself. See To assign or unassign the Leader role and To assign or unassign the Admin role.

Back to top

Can I invite non-members to a group?

You can invite individuals who are not platform members to a group, but non-members must sign up before accepting the group request via their personal Dashboard page.

Back to top

How do I accept an invitation to a group?

You can accept an invitation to join a group by approving the notification in your personal Dashboard.

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

    Note: Be sure to click Confirm. If you only click Accept, but not Confirm, you haven't yet accepted the invitation.

Back to top

How do I decline an invitation to a group?

You can decline a group invitation by selecting the Decline option in the notification in your personal Dashboard.

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

Back to top

How do I edit group information?

To edit group information:

To complete these steps, you must be an Admin for the group.

  1. Go to the Groups page. See How do I access a group?
  2. Click the name of the group. The Group Details page displays.
  3. Click Edit.
  4. In the Edit Group Info page, update information about the group, as needed:
    • Group Name: A brief descriptive name.
    • Group Description: Short descriptive summary about the group.
    • Tags: one or more key words that people can use to search for the group.
    • Visibility: Determines who can see the group. For details, see How does group visibility work?
  5. In the Group Icon section, you can upload an icon for your group. See How do I upload and crop icons?
  6. Click Save.

Back to top

How do I remove a group member?

An API Admin can remove a group member or leader. A leader can remove a group member.

To remove a group member:
  1. Go to the Groups page. See How do I access a group?
  2. Click the name of the group. The Group Details page displays.
  3. Click Members. The Members page displays.
  4. Find the member's name on the list, and click Remove.
  5. At the confirmation prompt, enter a comment if you want to, and then click Confirm. The group member is removed.

Back to top

How do I re-send a group member invitation?

You might need to re-send an invitation to a user to join a group. When you re-send an invitation, a new notification is sent to the invited user.

To re-send an invitation for group membership:
  1. Go to the Groups page. See How do I access a group?
  2. Click the name of the group. The Group Details page displays.
  3. Click Members. The Members page displays.
  4. Find the member on the list, and click Resend Email.
  5. At the confirmation popup, enter a message that will be included in the notification to the user, and then click Invite.

Back to top

How do I delete a group?

Only a group Admin can delete a group.

To delete a group:
  1. Go to the Groups page. See How do I access a group?
  2. Click the name of the group. The Group Details page displays.
  3. Click Delete. At the confirmation message, click OK. The group is deleted.

Back to top

Why can't I add a group?

In some cases, depending on the specific configuration settings of the developer portal you're using, you might find that you can't add a group.

Platform settings are controlled by the Site Admin.

Depending on the group type:

  • If you want to be able to add a platform group, and the Add Group option isn't available from the top menu bar, ask the Site Admin. For more information, see General Group Settings (Site Admin help).
  • If you want to be able to add an API Scope Group, and the Add Group option isn't available in the Visibility > Groups page, ask the Site Admin. For more information, see General API Settings (Site Admin help).

Back to top

API Scope Groups:

What is an API Scope Group?

An API Scope Group is a group that's created in the context of a specific API. There are two types of API Scope Group:

  • Independently Managed: the group can exist separately from the API; if the API is deleted, the group is not deleted.
  • Not Independently Managed: the group exists solely in the context of the API; if the API is deleted, the group is automatically deleted also.

Both types of API Scope Group work the same as other groups in the developer portal. The differences are:

  • An API Scope Group is created in the context of an API and is accessed in the user interface from the left menu for the API.
  • If an API Scope Group is created as Not Independently Managed, and the API is deleted, the group is deleted also.

Note: In some cases, depending on platform configuration, this feature might not be available. For more information, see Why can't I add a group?

Back to top

How do I add an API Scope Group?

An API Admin can create an API Scope Group in the context of the specific API, if this feature is enabled in the platform settings.

In the example shown below (Default Theme), there are no existing API Scope Groups.

adding an API Scope Group

In the API > Visibility > Groups page the API Admin can:

  • Add a new group: see To create an API Scope Group below.
  • Invite an existing group to have visibility of the API: click Invite Group, find the group on the Groups List, and click OK.

Note: you can only add an API Scope Group if you are an Admin for the API.

To create an API Scope Group
  1. Log in as the API Admin and go to the My APIs page.
  2. Choose the API and then, from the left menu bar, click Visibility > Groups.
  3. Click Create Group.
  4. In the Start Your New Group page, enter information about the group:
    • Group Name: A brief descriptive name.
    • Group Description: Short descriptive summary about the group.
    • Tags: one or more key words that people can use to search for the group.
    • Visibility: Determines who can see the group. For details, see How does group visibility work?
  5. In the Group Icon section, you can upload an icon for your group. See How do I upload and crop icons?
  6. Click Save.

Back to top

What are the components of the API > Visibility > Groups page?

The APIs section includes a Visibility > Groups page that allows API Admins to manage API Scope Groups. An example is shown below (Hermosa Theme).

API Scope Groups page

From here, the API Admin can:

  • Create a new API Scope Group: click Create Group. See To create an API Scope Group.
  • Invite an existing group to have visibility of the API: click Invite Group, find the group on the list, and then click Invite Group to the right of the line.
  • Withdraw an existing invitation: click Uninvite and then, at the confirmation message, click OK.
  • Delete an API Scope Group that was created as Not Independently Managed: click Delete and then, at the confirmation message, click OK.

Back to top

How do I access an API Scope Group?

To access an API Scope Group:
  1. Click My APIs > API Name > Visibility > Groups. The Group Summary page displays.
  2. Find the group you want, and click the title to go to the Details page for the group.

Back to top

How do I delete an API Scope Group?

To complete these steps, you must be an Admin for the group.

To delete an API Scope Group:
  1. Navigate to APIs > Visibility > Groups. The Group Summary page displays.
  2. Find the group you want, and click the title to go to the Details page for the group.
  3. Click Delete.
  4. At the confirmation message, click OK. The group is deleted.

Back to top

Group Ratings and Reviews:

Where can I find rating and review information for each group?

Each group can include rating and review information submitted by platform community members. The information is available on the Group Details page as follows:

  • Peer Rating—This section uses a star rating system to record positive feedback. A rating counter displays feedback for each rating number (1–5 stars, with 5 being the best rating), and displays an average rating.
  • Peer Review—This section has a list of written reviews submitted by the platform community for the current group. You can browse the reviews and filter information by Most Recent, Most Popular, Current or All versions, or enter a search tag.
  • Thumbs-Up—You can also give a thumbs-up vote to reviews as well as to Forum entries such as comments.

Back to top

How do I rate a group?

You can rate a group on the Group Details page. Follow the instructions below.

To rate a group:
  1. Go to the Groups page. See How do I access a group?
  2. Click the name of the group. The Group Details page displays.
  3. In the Peer Rating section, go to Rate this Group and click the star that represents the level of positive feedback you want to submit for the current group. The rating counter increments by one next to the star rating you selected and the star rating turns red.

Back to top

How do I review a group?

You can review a group on the Group Details page. Follow the instructions below.

To write a review for a group:
  1. Go to the Groups page. See How do I access a group?
  2. Click the name of the group. The Group Details page displays.
  3. Go to the Write a Review section.
  4. In the Title text box, enter a title for the review.
  5. In the Review text box, enter the review contents. If Markdown is supported for reviews on the platform, you'll see the Markdown icons above the review comment box. For more information, see How do I use Markdown in my discussions, tickets, alerts, reviews, or comments?
  6. After writing your review, click Save. The review is posted. Community members can now read your review and rate whether it was helpful.

Note: In some scenarios, an approval process might be in place for reviews. If that's the case, you'll see that your review is in a Pending state. At that point, others will not see your review until it's approved. An Admin is notified that the review is pending approval, and will approve (or reject) your review as soon as possible.

Back to top

How do I edit a group review?

If you've added a group review and want to change the content, you can edit the review on the Group Details page as follows.

Note: You can only change the content of your own review.

To edit a group review:
  1. Go to the Groups page. See How do I access a group?
  2. Click the name of the group. The Group Details page displays.
  3. In the Your Review section, you'll see the review. Click Edit.
  4. Edit the review title and/or content, and then click Save.

Back to top

How do I delete a group review?

You can delete a group review on the Group Details page.

To delete a group review:
  1. Go to the Groups page. See How do I access a group?
  2. Click the name of the group. The Group Details page displays.
  3. In the Your Review section, you'll see the review. Click Delete.
  4. At the confirmation message, click OK. The review is deleted.

Back to top