> For the complete documentation index, see [llms.txt](https://docs.spectralink.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.spectralink.net/amie-advanced/using-the-platform/settings/settings-group-details.md). # Group Details The **Group Details** tab of the [Settings](/amie-advanced/using-the-platform/settings.md) screen holds the enrollment ID for the group selected in the header: the code a handset's AMIE Agent app needs to join that group. To reach it, select **Settings** in the sidebar, then the **Group Details** tab. ## Why this screen matters A handset joins your Space by enrolling with a group's enrollment ID, and the group it enrolls into decides who can see it afterwards. This tab is where you start enrollment for a group, copy the ID to give to the people configuring handsets, and end enrollment when a group should accept no more handsets. Treat each ID as a standing code for its group rather than something to rotate: every handset configured with it keeps working, and a new ID means reconfiguring handsets that have not yet joined. ## Before you start The tab follows the [group selector](/amie-advanced/using-the-platform/the-console.md#the-group-selector) in the header: it always shows the enrollment ID of the selected group, and switching groups switches the ID. Select the group the handsets should join before you copy anything. Grayed out? The copy icon, **Start Enrollment** and **End Enrollment** depend on your role, and for the **User** and **Viewer** roles the **Enrollment ID** reads **You don't have permission to view this**. Requires the **Admin** or **Owner** role — see [Roles and permissions](/amie-advanced/using-the-platform/roles-and-permissions.md). ## Screen layout ### Enrollment Settings A heading, **Enrollment Settings**, and the sentence **Devices can enroll into this space using the enrollment ID below.** The ID is for the group named under **Current Group**, not for the whole Space: each group has its own. ### Current Group **Current Group** names the group selected in the header. It reads **—** while the group tree is still loading, and if the selected group is not one this tab can find. ### Enrollment ID **Enrollment ID** shows the group's current ID in large, evenly spaced characters, with a copy icon beside it (named **Copy enrollment ID** for screen readers). | Situation | **Enrollment ID** reads | What to do | | ----------------------------------------------------------------------------------------- | ------------------------------------------ | ------------------------------------------------------ | | Enrollment is running for this group | The ID itself | Copy it and give it to the people configuring handsets | | Enrollment is not running: none was ever started, it was ended, or the last ID has lapsed | **No enrollment ID available** | Select **Start Enrollment** | | Your role is **User** or **Viewer** | **You don't have permission to view this** | Ask an **Admin** or **Owner** for the ID | | The ID could not be fetched | **Failed to load enrollment ID** | Reload the page | | The ID is still being fetched | **…** | Wait | Beneath it is one button: **Start Enrollment** when there is no ID, or **End Enrollment**, in red, when there is one. Which handsets an ID can place depends on where each handset already sits. A handset in no group — a new one, or one that has been removed from your Space — joins the group whose ID it is configured with, so a handset that still carries an old group's ID rejoins that old group unless you give it the new one first. A handset already in a group is refused by another group's ID, and re-enrolling with a different ID does not move it; moving a handset between groups is not yet available in the console. \[GAP-devices-3] An enrollment ID does not last forever. When it lapses, **Enrollment ID** reads **No enrollment ID available** again; select **Start Enrollment** to create a new one and give it to any handsets still to be enrolled. Handsets already enrolled are unaffected. {% hint style="warning" %} TODO: how long an enrollment ID remains usable, and whether the console can show when one expires. {% endhint %} ### How Enrollment Works **How Enrollment Works** repeats the three rules. In all three, "this space" means the group named under **Current Group**, not the whole Space. The first reads **Devices use the enrollment ID to join this space.** The second reads **Ending enrollment prevents new devices from joining using this ID.** The third reads **Devices already enrolled in this space are not affected.** ## Controls | Control | What it does | | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Copy icon | Copies the ID to your clipboard. A brief message reads **Enrollment ID copied**. Grayed out when there is no ID | | **Start Enrollment** | Creates an ID for the group, replacing any lapsed one. A brief message reads **Enrollment started** and the ID appears. It is not offered while the group has a working ID: end that one first | | **End Enrollment** | Opens a confirmation headed **End Enrollment?** — see [End enrollment for a group](#end-enrollment-for-a-group) | ## Icons and indicators | Icon or indicator | Meaning | When it appears | | ---------------------------------------- | -------------------------------- | --------------------------------- | | Two overlapping squares beside the ID | The copy button | Always; grayed out without an ID | | Red **End Enrollment** button | Enrollment is running | When the group has an ID | | Blue **Start Enrollment** button | Enrollment is not running | When the group has no ID | | Spinning icon in place of a button label | The ID is being created or ended | Briefly after pressing the button | ## Common tasks ### Start enrollment and copy the ID Requires the **Admin** or **Owner** role. {% stepper %} {% step %} In the [group selector](/amie-advanced/using-the-platform/the-console.md#the-group-selector), select the group the handsets should join. **Current Group** shows its name. {% endstep %} {% step %} If **Enrollment ID** reads **No enrollment ID available**, select **Start Enrollment**. A brief message reads **Enrollment started** and the ID appears. {% endstep %} {% step %} Select the copy icon. A brief message reads **Enrollment ID copied**. Paste the ID into the handsets' AMIE Agent settings — see [Connecting handsets](/amie-advanced/planning-and-installation/connecting-devices.md). {% endstep %} {% endstepper %} ### End enrollment for a group Requires the **Admin** or **Owner** role. {% stepper %} {% step %} Select the group in the [group selector](/amie-advanced/using-the-platform/the-console.md#the-group-selector) and check **Current Group** names it. {% endstep %} {% step %} Select **End Enrollment**. A confirmation headed **End Enrollment?** reads **This will prevent any new devices from enrolling into this space using the current enrollment ID. This action cannot be undone.** {% endstep %} {% step %} Select **End Enrollment** in the confirmation (**Cancel** keeps the ID). A brief message reads **Enrollment ended** and **Enrollment ID** reads **No enrollment ID available**. Handsets already in the group are unaffected; a handset still configured with the old ID will not join. {% endstep %} {% endstepper %} ## What to look for * **Enrollment ID** reading **No enrollment ID available** on a group whose handsets are being set up. Enrollment was ended, or the ID lapsed. Select **Start Enrollment** and hand out the new ID; any handset configured with the old one has to be updated. * A handset appearing in the wrong group on the Devices [Inventory](/amie-advanced/using-the-platform/devices-inventory.md). It was configured with that group's ID. Check which group was selected in the header when the ID was copied. * **Enrollment ID** reading **You don't have permission to view this**. Your role is **User** or **Viewer**; ask an **Admin** or **Owner** for the ID — see [Roles and permissions](/amie-advanced/using-the-platform/roles-and-permissions.md). * **Enrollment ID** reading **Failed to load enrollment ID**. Reload the page. If it persists, contact Spectralink — see [Getting help](/amie-advanced/introduction/getting-help.md). ## Metrics on this screen None. ## Related * [Connecting handsets](/amie-advanced/planning-and-installation/connecting-devices.md) — configuring the AMIE Agent with the ID and checking the handset reports * [Groups](/amie-advanced/using-the-platform/settings/settings-groups.md) — creating the group before you start enrollment for it * [Devices inventory](/amie-advanced/using-the-platform/devices-inventory.md) — where an enrolled handset appears, with its **Group** --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.spectralink.net/amie-advanced/using-the-platform/settings/settings-group-details.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.