Eligibility groups

For what this feature does and how to activate it, see Eligibility groups in Platform. This item appears in the Control Center provider sidebar only when the eligibility groups provider feature is active.

Manage eligibility groups

Permissions: manage_eligibility_groups

From the provider view in Control Center, open ⚙️ > Manage eligibility groups.

The eligibility groups overview shows each group with its name, slug, invite strategies, default membership state, creation time, and number of users.

Create or edit an eligibility group

To create an eligibility group, select Create new. To edit an existing group, open it and select Edit from the actions menu.

Enter the following information.

FieldDescription
NameThe name shown in Control Center. The name must be unique within the provider.
SlugA stable identifier for the group. It can be set when the group is created and is read-only afterward.
Invite strategiesOne or more strategies that can add users to the group. See Invite strategies.
Default membership stateThe state applied when a strategy adds a user and the strategy does not define its own state. The available values are Pending and Active.
Eligible email domainsConfiguration for Automatically assign by email domain. Enter a comma-separated list of domains. Each domain must start with @, for example @example.com.

The Eligible email domains field is used only by the Automatically assign by email domain strategy. Manual assignment and Invite users via email do not have additional configuration fields.

When an eligibility group is created or updated, ioki Platform synchronizes the group’s memberships after the change.

Invite strategies

Eligibility groups support the following invite strategies.

StrategyHow users become membersConfiguration fieldsResulting membership state
Manual assignmentAn administrator manually assigns the user in Control Center.No additional fields. Enable Manual assignment in Invite strategies.The membership becomes Active.
Automatically assign by email domainioki Platform adds unarchived provider users whose email address matches one of the configured domains.Enable Automatically assign by email domain and enter Eligible email domains. Domains are comma-separated and must start with @.The membership uses the group’s Default membership state.
Invite users via emailAn administrator sends a membership invitation to the user from the user’s detailed view. The user must accept the invitation.No additional fields. Enable Invite users via email in Invite strategies.The membership becomes Awaiting user acceptance until the user accepts the invitation. After acceptance, it becomes Active.

For Invite users via email, Control Center can send an invitation only when the user has an email address and the user’s segment allows confirmation emails. Invitation links expire after 14 days. Administrators can resend the invitation while the membership is still awaiting user acceptance.

Membership states

Eligibility group memberships can have the following states.

StateMeaning
PendingThe user has been added but is not active yet. An administrator can approve, reject, or block the membership.
ActiveThe user is an active member of the group.
RejectedAn administrator rejected the membership. It can be reactivated if the membership still has an active strategy.
RevokedThe membership no longer has an active strategy.
BlockedAn administrator blocked the membership. Blocking removes the active strategies.
Awaiting user acceptanceThe user was invited by email and must accept the invitation before the membership becomes active.

Manage memberships from an eligibility group

Permissions: manage_eligibility_group_memberships to add, change, or remove memberships; read_users to view them.

The eligibility group detail page organizes memberships into these sections:

  • Pending memberships
  • Active memberships
  • Inactive memberships, which include rejected, revoked, and blocked memberships
  • Awaiting user acceptance

Depending on the membership state and enabled invite strategies, administrators can:

  • approve a pending membership
  • reject a membership
  • block a membership
  • reinstate an inactive membership that still has an active strategy
  • add or remove a manual assignment
  • resend an invitation email

Manage memberships from a user

The detailed view of a user shows the provider’s eligibility groups and the user’s membership state for each group.

From this section, administrators can:

  • add or remove a manual assignment when Manual assignment is enabled for the group
  • send or resend an email invitation when Invite users via email is enabled for the group
  • remove the Invite users via email strategy from an active membership
  • reject a membership
  • activate a membership that is not already active, as long as the membership still has an active strategy