From 98e4e768aeefa1b708c8e729292257084c8ce3da Mon Sep 17 00:00:00 2001 From: Anthony Carta Date: Wed, 11 Feb 2026 14:36:13 -0600 Subject: [PATCH 1/5] feat: add initial IAM docs --- docs/_sidebar.md | 8 +++++--- docs/iam/overview.md | 16 ++++++++++++++++ docs/iam/roles.md | 7 +++++++ docs/iam/users.md | 22 ++++++++++++++++++++++ 4 files changed, 50 insertions(+), 3 deletions(-) create mode 100644 docs/iam/overview.md create mode 100644 docs/iam/roles.md create mode 100644 docs/iam/users.md diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 1d8004e..a08f288 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -25,7 +25,9 @@ - [Window Events](window/events.md "Botcopy Docs | Window Events") - [Window Methods](window/methods.md "Botcopy Docs | Window Methods") - WCAG 2.1 - - [Compliance](wcag/focus-trap.md "Botcopy Docs | Focus Trap") - - +- IAM + - [Overview](iam/overview.md "Botcopy Docs | Overview") + - [Users Page](iam/users.md "Botcopy Docs | Users Page") + - [Roles Page](iam/roles.md "Botcopy Docs | Roles Page") + diff --git a/docs/iam/overview.md b/docs/iam/overview.md new file mode 100644 index 0000000..b9fbdbc --- /dev/null +++ b/docs/iam/overview.md @@ -0,0 +1,16 @@ +## IAM Overview + +The IAM application is used to manage user roles, delete users, and invite new users to an organization. The IAM application can be found [here](https://iam.botcopy.com). + +### Roles + +| **Role Name** | **Description** | +| ----------------- | --------------------------------------------------------------------------------------------------------------- | +| `PORTAL_ADMIN` | Portal administrator role, full access to all portal features. | +| `PORTAL_DEV` | Portal developer role, access to most portal features with some exceptions. | +| `PORTAL_MARKETER` | Portal marketer role, access to some portal features. For users that only need permission to edit bot branding. | +| `PORTAL_BILLING` | Portal billing role, access to some portal features. For users that only need access to billing. | + +### Access + +All users in an organization have access to the IAM application. However, only users with the `PORTAL_ADMIN` role will be able to edit roles, delete users, and invite new users. `PORTAL_ADMINS` cannot edit their own access or delete themselves from an organzation, that needs to be done by another `PORTAL_ADMIN`. diff --git a/docs/iam/roles.md b/docs/iam/roles.md new file mode 100644 index 0000000..9ec457e --- /dev/null +++ b/docs/iam/roles.md @@ -0,0 +1,7 @@ +## IAM Roles Page + +The "Roles" page groups roles with the users that are assigned to that role into a table. The table can be searched (case insensitive) and sorted by role. In addition to displaying roles and the users assigned to them, this page will allow you to update users assigned to a given role. + +### Updating Role Assignments + +To update the users assigned to a role, click the three dot button on the row and select “Edit Users” from the menu. All users in the organization appear in the modal. If you remove the only role a user has, you will be directed to delete the user instead. An update that removes the only role a user has will not be applied. diff --git a/docs/iam/users.md b/docs/iam/users.md new file mode 100644 index 0000000..1b10f93 --- /dev/null +++ b/docs/iam/users.md @@ -0,0 +1,22 @@ +## IAM Users Page + +The "Users" provides the ability to grant access to new users, delete users, and edit their role assignments. The current users in an organization are displayed in a table along with their current role assignments and the date of their last sign in to Portal. + +### Granting Access + +Click the "Grant Access" button to open a modal where users can be invited and assigned an initial role. Users that are eligible to be invited to an organization: + +- valid and active email address + - **Note:** email addresses are not validated for activity by the IAM app +- users that have never been invited to any organization +- users that were deleted from another organization + +Upon clicking the “Grant” button, the emails addresses will receive an email that contains a link to Portal. + +### Deleting Users + +To delete a user from an organization, click the three dot button on the user's row and select “Delete User” from the menu that appears. A modal will open to confirm the deletion. Once a user is deleted, they are eligible to be invite to another organization. + +### Editing User Roles + +To update roles for a user, click the three dot button on the row and select “Edit Roles” from the menu that appears. A modal will open that shows that users current roles. All active users must have at least one role, so the “Confirm” button will be disabled if no checkboxes are selected. From b129e5a275948e7d55b61b3cd7e10d949f8640ab Mon Sep 17 00:00:00 2001 From: Copilot <198982749+Copilot@users.noreply.github.com> Date: Wed, 11 Feb 2026 15:46:27 -0600 Subject: [PATCH 2/5] Fix spelling error in IAM documentation (#90) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Initial plan * Fix spelling: organzation → organization Co-authored-by: acarta99 <160150460+acarta99@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: acarta99 <160150460+acarta99@users.noreply.github.com> --- docs/iam/overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/iam/overview.md b/docs/iam/overview.md index b9fbdbc..aafb037 100644 --- a/docs/iam/overview.md +++ b/docs/iam/overview.md @@ -13,4 +13,4 @@ The IAM application is used to manage user roles, delete users, and invite new u ### Access -All users in an organization have access to the IAM application. However, only users with the `PORTAL_ADMIN` role will be able to edit roles, delete users, and invite new users. `PORTAL_ADMINS` cannot edit their own access or delete themselves from an organzation, that needs to be done by another `PORTAL_ADMIN`. +All users in an organization have access to the IAM application. However, only users with the `PORTAL_ADMIN` role will be able to edit roles, delete users, and invite new users. `PORTAL_ADMINS` cannot edit their own access or delete themselves from an organization, that needs to be done by another `PORTAL_ADMIN`. From 64e0f62aff7746aa33db23832c71ae9b04e258aa Mon Sep 17 00:00:00 2001 From: Anthony Carta Date: Wed, 11 Feb 2026 16:01:06 -0600 Subject: [PATCH 3/5] feat: apploy more copilot feedback --- docs/iam/roles.md | 4 ++-- docs/iam/users.md | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/iam/roles.md b/docs/iam/roles.md index 9ec457e..760cb99 100644 --- a/docs/iam/roles.md +++ b/docs/iam/roles.md @@ -1,7 +1,7 @@ ## IAM Roles Page -The "Roles" page groups roles with the users that are assigned to that role into a table. The table can be searched (case insensitive) and sorted by role. In addition to displaying roles and the users assigned to them, this page will allow you to update users assigned to a given role. +The "Roles" page groups roles with the users that are assigned to that role into a table. In addition to displaying roles and the users assigned to them, this page will allow you to update users assigned to a given role. ### Updating Role Assignments -To update the users assigned to a role, click the three dot button on the row and select “Edit Users” from the menu. All users in the organization appear in the modal. If you remove the only role a user has, you will be directed to delete the user instead. An update that removes the only role a user has will not be applied. +To update the users assigned to a role, click the three-dot menu in that row and select “Edit Users” from the menu. All users in the organization appear in the modal. If you remove the only role a user has, you will be directed to delete the user instead. An update that removes the only role a user has will not be applied. diff --git a/docs/iam/users.md b/docs/iam/users.md index 1b10f93..0a2d305 100644 --- a/docs/iam/users.md +++ b/docs/iam/users.md @@ -1,6 +1,6 @@ ## IAM Users Page -The "Users" provides the ability to grant access to new users, delete users, and edit their role assignments. The current users in an organization are displayed in a table along with their current role assignments and the date of their last sign in to Portal. +The "Users" provides the ability to grant access to new users, delete users, and edit their role assignments. The current users in an organization are displayed in a table along with their current role assignments and the date of their last sign-in to Portal. ### Granting Access @@ -11,11 +11,11 @@ Click the "Grant Access" button to open a modal where users can be invited and a - users that have never been invited to any organization - users that were deleted from another organization -Upon clicking the “Grant” button, the emails addresses will receive an email that contains a link to Portal. +Upon clicking the “Grant” button, the invited email addresses will receive an email that contains a link to Portal. ### Deleting Users -To delete a user from an organization, click the three dot button on the user's row and select “Delete User” from the menu that appears. A modal will open to confirm the deletion. Once a user is deleted, they are eligible to be invite to another organization. +To delete a user from an organization, click the three-dot menu on the user's row and select “Delete User” from the menu that appears. A modal will open to confirm the deletion. Once a user is deleted, they are eligible to be invited to another organization. ### Editing User Roles From 912b073f9dbf4feb2057a10ef5efc53540549f59 Mon Sep 17 00:00:00 2001 From: Anthony Carta Date: Mon, 16 Mar 2026 15:50:31 -0500 Subject: [PATCH 4/5] feat: add sentence about future roles --- docs/iam/overview.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/iam/overview.md b/docs/iam/overview.md index aafb037..c8c57bd 100644 --- a/docs/iam/overview.md +++ b/docs/iam/overview.md @@ -11,6 +11,8 @@ The IAM application is used to manage user roles, delete users, and invite new u | `PORTAL_MARKETER` | Portal marketer role, access to some portal features. For users that only need permission to edit bot branding. | | `PORTAL_BILLING` | Portal billing role, access to some portal features. For users that only need access to billing. | +More granular roles are planned for release in the future. + ### Access All users in an organization have access to the IAM application. However, only users with the `PORTAL_ADMIN` role will be able to edit roles, delete users, and invite new users. `PORTAL_ADMINS` cannot edit their own access or delete themselves from an organization, that needs to be done by another `PORTAL_ADMIN`. From 83949131228e575ddee3967e3f58f84d0707b903 Mon Sep 17 00:00:00 2001 From: Anthony Carta Date: Mon, 16 Mar 2026 15:55:31 -0500 Subject: [PATCH 5/5] feat: invite emails no longer expire --- docs/iam/users.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/iam/users.md b/docs/iam/users.md index 0a2d305..93c8786 100644 --- a/docs/iam/users.md +++ b/docs/iam/users.md @@ -11,7 +11,7 @@ Click the "Grant Access" button to open a modal where users can be invited and a - users that have never been invited to any organization - users that were deleted from another organization -Upon clicking the “Grant” button, the invited email addresses will receive an email that contains a link to Portal. +Upon clicking the “Grant” button, the invited email addresses will receive an email that contains a link to Portal. Invitation emails no longer expire. Once a user has been added via the "Grant Access" functionality they have access to the organization right away. ### Deleting Users