> ## Documentation Index
> Fetch the complete documentation index at: https://docs.aviatrix.com/llms.txt
> Use this file to discover all available pages before exploring further.

# User Access

> This section provides the purpose, elements, and actions performed on the User Access pages.

This section provides the purpose, elements, and actions performed on the **User
Access** pages.

<Tabs>
  <Tab title="Users">
    ## Purpose

    The **Users** page shows user accounts and their permission group assignments.
    You can view, add, and edit users from this page. Each user must belong to at
    least one permission group to access CoPilot.

    ## Elements

    <Frame>
      <img src={"/images/reference/ui/administration/users.png"} alt="User Access: Users" width="100%" />
    </Frame>

    * **+ User button**: Opens dialog to create new user.
    * **Search box**: Filters users by name or email.
    * **Filter button**: Shows filter options for the table.
    * **Columns button**: Selects visible columns in the table.
    * **Export button**: Exports table data.
    * **Users table**: Shows list of users with name, email, and permission groups.
    * **Edit button**: Edits user configuration.
    * **Delete button**: Deletes user account.
    * **Actions button**: Opens additional actions menu.
    * **Refresh button**: Refreshes table data.

    ## Actions

    <AccordionGroup>
      <Accordion title="View Users">
        To view users:

        1. Go to **Administration** > **User Access** > **Users**.
        2. The Users page appears with the table (Name, Email, Permission Groups) and **+ User**, **Search**, **Filter**, **Columns**, **Export**, **Refresh**.
        3. Optionally, use **Search**, **Filter**, or **Columns** to narrow the list.

        The users table shows all user accounts and their permission group assignments.

        ### Parameter Details

        | CoPilot Parameter Name | Description                               |
        | ---------------------- | ----------------------------------------- |
        | Name                   | Shows user name.                          |
        | Email                  | Shows user email address.                 |
        | Permission Groups      | Shows permission groups assigned to user. |
      </Accordion>

      <Accordion title="Add User">
        To add a user:

        1. Go to **Administration** > **User Access** > **Users**.
        2. Click **+ User**.
        3. In the dialog, enter **Name**, **Email**, **Password**, and select **Permission Groups**. Click **Save**.

        A notification appears confirming the user was created.

        ### Parameter Details

        | CoPilot Parameter Name | Description                                                                                      |
        | ---------------------- | ------------------------------------------------------------------------------------------------ |
        | Name                   | Enter the user's name (you can also add a job title or description).                             |
        | Email                  | Enter the user's email or email mailing list.                                                    |
        | Password               | Enter a strong password or passphrase for the user.                                              |
        | Permission Groups      | Select the permission groups this user should belong to (each user must belong to at least one). |
      </Accordion>

      <Accordion title="Edit User">
        To edit a user:

        1. Go to **Administration** > **User Access** > **Users**.
        2. Locate the user in the table and click **Edit**.
        3. In the dialog, update **Name**, **Email**, **Password**, and **Permission Groups** as needed. Click **Save**.

        A notification appears confirming the user was updated.

        ### Parameter Details

        | CoPilot Parameter Name | Description                                                                 |
        | ---------------------- | --------------------------------------------------------------------------- |
        | Name                   | Edit the user's name as needed.                                             |
        | Email                  | Edit the user's email address.                                              |
        | Password               | Edit the user's password if needed.                                         |
        | Permission Groups      | Add or remove permission groups (click dropdown to add; click x to remove). |
      </Accordion>
    </AccordionGroup>
  </Tab>

  <Tab title="Permission Group">
    ## Purpose

    The **Permission Group** page shows permission groups that define which areas,
    pages, and tabs of CoPilot users can access and which Controller permissions
    they have. You can view, create, and edit permission groups to enforce granular
    access control.

    ## Elements

    <Frame>
      <img
        src={
  "/images/reference/ui/administration/permission-group.png"
}
        alt="User Access: Permission Group"
        width="100%"
      />
    </Frame>

    * **+ Permission Group button**: Opens dialog to create new permission group.
    * **Search box**: Filters permission groups by name.
    * **Filter button**: Shows filter options for the table.
    * **Columns button**: Selects visible columns in the table.
    * **Export button**: Exports table data.
    * **Permission Groups table**: Shows list of permission groups with name,
      CoPilot visibility, and controller permissions.
    * **Edit button**: Edits permission group configuration.
    * **Delete button**: Deletes permission group.
    * **Refresh button**: Refreshes table data.

    ## Actions

    <AccordionGroup>
      <Accordion title="View Permission Groups">
        To view permission groups:

        1. Go to **Administration** > **User Access** > **Permission Group**.
        2. The page appears with the table (Name, Copilot Visibility, Controller Permissions) and **+ Permission Group**, **Search**, **Filter**, **Columns**, **Export**, **Refresh**.
        3. Optionally, use **Search**, **Filter**, or **Columns** to narrow the list.

        The permission groups table shows all groups and their visibility and controller
        permissions.

        ### Parameter Details

        | CoPilot Parameter Name | Description                                             |
        | ---------------------- | ------------------------------------------------------- |
        | Name                   | Shows permission group name.                            |
        | Copilot Visibility     | Shows CoPilot visibility settings for permission group. |
        | Controller Permissions | Shows controller permissions for permission group.      |
      </Accordion>

      <Accordion title="Create Permission Group">
        To create a permission group:

        1. Go to **Administration** > **User Access** > **Permission Group**.
        2. Click **+ Permission Group**.
        3. In the dialog, enter **Name**, select **Users** and **Cloud Accounts** (Access Accounts), configure **CoPilot Visibility** and **Controller Permissions**. Click **Save**.

        A notification appears confirming the permission group was created.

        ### Parameter Details

        | CoPilot Parameter Name           | Description                                                                                              |
        | -------------------------------- | -------------------------------------------------------------------------------------------------------- |
        | Name                             | Enter a clear name for this Permission Group.                                                            |
        | Users                            | Select users to add to this Permission Group.                                                            |
        | Cloud Accounts (Access Accounts) | Select which Cloud Accounts members of this group should be able to access.                              |
        | CoPilot Visibility               | Select which pages and tabs users in this group can access in CoPilot (write access for selected areas). |
        | Controller Permissions           | Select which Controller permissions (API/Terraform) this group has.                                      |
      </Accordion>

      <Accordion title="Edit Permission Group">
        To edit a permission group:

        1. Go to **Administration** > **User Access** > **Permission Group**.
        2. Locate the group in the table and click **Edit**.
        3. In the dialog, update **Users**, **Cloud Accounts** (Access Accounts), **CoPilot Visibility**, and **Controller Permissions** (Name is read-only). Click **Save**.

        A notification appears confirming the permission group was updated.

        ### Parameter Details

        | CoPilot Parameter Name           | Description                                                         |
        | -------------------------------- | ------------------------------------------------------------------- |
        | Name                             | Shows permission group name (read-only when editing).               |
        | Users                            | Select users to assign to this permission group.                    |
        | Cloud Accounts (Access Accounts) | Select which Cloud Accounts members of this group can access.       |
        | CoPilot Visibility               | Edit which areas, pages, and tabs this group can access in CoPilot. |
        | Controller Permissions           | Edit which Controller features this group can access.               |
      </Accordion>
    </AccordionGroup>
  </Tab>

  <Tab title="Access Management">
    ## Purpose

    The **Access Management** page lets you manage access for all users: password
    policy, refresh of credentials on Controller and gateways, ability for the admin
    user to log in, and login authentication (SAML, LDAP, Duo, and local login by
    permission group).

    ## Elements

    <Frame>
      <img
        src={
  "/images/reference/ui/administration/access-management.png"
}
        alt="User Access: Access Management"
        width="100%"
      />
    </Frame>

    * **Password Policy section**: Shows password policy settings including minimum
      password length, maximum password age, and password history enforcement.
    * **Edit Configuration button**: Opens dialog to edit password policy
      configuration.
    * **More Options button**: Opens additional configuration options.
    * **Refresh Credentials section**: Section with button to refresh credentials on
      controller and gateways.
    * **Refresh button**: Refreshes credentials on controller and gateways.
    * **Allow Admin User to Login toggle**: Toggle switch to allow admin user to
      login.
    * **SAML section**: Section for managing SAML endpoints with table showing SAML
      endpoint configurations.
    * **+ SAML Endpoint button**: Opens dialog to create new SAML endpoint.
    * **LDAP section**: Section for managing LDAP authentication.
    * **Enable button**: Enables LDAP authentication.
    * **Duo section**: Section for managing Duo authentication.
    * **Enable button**: Enables Duo authentication.
    * **Allow Local Login section**: Section for configuring local login
      permissions.
    * **Permission Groups dropdown**: Selects permission groups for local login.
    * **Search box**: Filters SAML endpoints.

    ## Actions

    <AccordionGroup>
      <Accordion title="View Access Management">
        To view access management settings:

        1. Go to **Administration** > **User Access** > **Access Management**.
        2. The page appears with Password Policy, Refresh Credentials, Allow Admin User to Login, SAML, LDAP, Duo, and Allow Local Login sections.
        3. Optionally, use **Edit Configuration**, **Refresh**, toggles, or **+ SAML Endpoint** to manage settings.

        The Access Management page displays security and authentication configuration.

        ### Parameter Details

        | CoPilot Parameter Name | Description                                       |
        | ---------------------- | ------------------------------------------------- |
        | Name                   | Shows SAML endpoint name.                         |
        | Permission Group       | Shows permission group assigned to SAML endpoint. |
        | Access Set By          | Shows how access is set for SAML endpoint.        |
        | Test                   | Shows test status or button for SAML endpoint.    |
      </Accordion>
    </AccordionGroup>
  </Tab>
</Tabs>