diff --git a/docs/portal/audit-trail.md b/docs/portal/audit-trail.md new file mode 100644 index 000000000..6026f0e2b --- /dev/null +++ b/docs/portal/audit-trail.md @@ -0,0 +1,12 @@ +--- +title: Audit Trail +description: View a detailed log of past actions performed on the UID2 Portal. +hide_table_of_contents: false +sidebar_position: 09 +--- + +import Link from '@docusaurus/Link'; + +# Audit Trail + +In the UID2 Portal, Admin users can access the **Audit Trail** page to view a detailed log of all past actions performed by or on behalf of the current participant. The table displays the action performed, the user who performed it, the time it was performed, and whether it succeeded. The Audit Trail table also supports sorting and searching. \ No newline at end of file diff --git a/docs/portal/email-contacts.md b/docs/portal/email-contacts.md index 0a3bdc50e..4d8e4c4b0 100644 --- a/docs/portal/email-contacts.md +++ b/docs/portal/email-contacts.md @@ -21,7 +21,7 @@ Email contacts cannot log in to the UID2 Portal or modify the account. They only ## Accessing the Email Contacts Page -To access the Email Contacts page, go to the top right of the UID2 Portal user interface where your login ID is displayed. Click the down arrow and choose **Email Contacts**. +To access the Email Contacts page, go to the top right of the UID2 Portal user interface where your name is displayed. Click the down arrow and choose **Email Contacts**. For an illustration, see [UID2 Portal Structure](portal-overview.md#uid2-portal-structure). diff --git a/docs/portal/images/portal-uid2-overview.png b/docs/portal/images/portal-uid2-overview.png index abfd0f7ab..b7d3ce022 100644 Binary files a/docs/portal/images/portal-uid2-overview.png and b/docs/portal/images/portal-uid2-overview.png differ diff --git a/docs/portal/participant-info.md b/docs/portal/participant-info.md index d3a6b72ca..92163b061 100644 --- a/docs/portal/participant-info.md +++ b/docs/portal/participant-info.md @@ -13,7 +13,7 @@ As part of requesting a UID2 Portal account, you must provide some information a In the UID2 Portal, some of this information is displayed. When you have access, verify that the information is accurate. -To access the page, go to the top right of the UID2 Portal user interface where your login ID is displayed. Click the down arrow and choose **Participant Information**. +To access the page, go to the top right of the UID2 Portal user interface where your name is displayed. Click the down arrow and choose **Participant Information**. For an illustration, see [UID2 Portal Structure](portal-overview.md#uid2-portal-structure). diff --git a/docs/portal/portal-getting-started.md b/docs/portal/portal-getting-started.md index 7de83d1a4..69ef86602 100644 --- a/docs/portal/portal-getting-started.md +++ b/docs/portal/portal-getting-started.md @@ -121,7 +121,7 @@ The following table includes details of the information you'll need, and a link | Item | Details | Link to Instructions | | :--- | :--- | :--- | -| Team member information | For each, provide the following:
- First name
- Last name
- Email
- Job function | [Team Members](team-members.md) | +| Team member information | For each, provide the following:
- First name
- Last name
- Email
- Job function
- Role | [Team Members](team-members.md) | | Email contact information | For each, provide the following:
- Email group name
- Email alias
- Contact type | [Email Contacts](email-contacts.md) | ## Reset Password diff --git a/docs/portal/portal-overview.md b/docs/portal/portal-overview.md index c39a961f7..4d11f4673 100644 --- a/docs/portal/portal-overview.md +++ b/docs/portal/portal-overview.md @@ -21,6 +21,7 @@ The UID2 Portal is your one-stop shop for setting up and configuring your UID2 a | Configure permissions for individual sharing participants or groups of sharing participants.
NOTE: Use of sharing requires an API key (see [API Keys](api-keys.md)) or client-side key pair (see [Client-Side Integration](client-side-integration.md)). Configure these values before setting up sharing permissions. | [Sharing Permissions](sharing-permissions.md) | | Add team members who will have permission to manage your account. | [Team Members](team-members.md) | | Set up designated email contacts who will be notified of news or updates. | [Email Contacts](email-contacts.md) | +| View a detailed log of all past actions performed by, or on behalf of, the current participant. | [Audit Trail](audit-trail.md) | ## Access the UID2 Portal @@ -36,20 +37,23 @@ There are two main ways to access the pages, as shown in the following image: ![UID2 Portal Structure](images/portal-uid2-overview.png) -From the left sidebar, you can access the following pages relating to configuring your account: +Your participant name will be displayed at the top of the left sidebar. If your account has access to multiple participants, as shown in the example above, a dropdown menu will appear. You can use this menu to switch between participants in the portal. + +Continuing down the left sidebar, you can access the following pages relating to configuring your account: - Home: link to home page, always present. - [Sharing Permissions](sharing-permissions.md) - [API Keys](api-keys.md) - [Client-Side Integration](client-side-integration.md) -From the link at the top right, your user ID and image are displayed. If you have a Gravatar image set up (see [https://gravatar.com/](https://gravatar.com/)), your image is displayed. If you don't have a Gravatar image, a default image is displayed. +From the link at the top right, your name is displayed. From here, you can access the following pages relating to your personal account settings and your daily activities: - [Participant Information](participant-info.md) - [Manage Team Members](team-members.md) - [Email Contacts](email-contacts.md) +- [Audit Trail](audit-trail.md) (Admin users only) - Dark Mode: toggles dark mode on and off - [Log Out](portal-getting-started.md#log-out) diff --git a/docs/portal/team-members.md b/docs/portal/team-members.md index 588000174..2d4fbbd53 100644 --- a/docs/portal/team-members.md +++ b/docs/portal/team-members.md @@ -9,7 +9,7 @@ import Link from '@docusaurus/Link'; # Team Members -In the UID2 Portal, on the **Team Members** page, you can perform all activities relating to configuring individuals who you want to authorize for access to your account, including the following: +In the UID2 Portal, on the **Team Members** page, Admin users can perform all activities relating to configuring individuals who you want to authorize for access to your account, including the following: - [Add a Team Member](#add-a-team-member) - [Resend an Invitation to a Team Member](#resend-an-invitation-to-a-team-member) @@ -18,17 +18,17 @@ In the UID2 Portal, on the **Team Members** page, you can perform all activities ## Accessing the Team Members Page -To access the Team Members page, go to the top right of the UID2 Portal user interface where your login ID is displayed. Click the down arrow and choose **Manage Team Members**. +To access the Team Members page, go to the top right of the UID2 Portal user interface where your name is displayed. Click the down arrow and choose **Manage Team Members**. For an illustration, see [UID2 Portal Structure](portal-overview.md#uid2-portal-structure). -## Team Member Rights and Responsibilities +## User Roles -Each team member is an administrator for the account, and can perform all activities relating to managing your team and your account, including the following: +Each team member has one of two user roles: Admin or Operations. Admin users can perform all activities related to UID2 participation, as summarized in the [UID2 Portal Overview](portal-overview.md). -- Add, modify, or remove additional team members: see [Add a Team Member](#add-a-team-member) -- Add, modify, or remove email contacts: see [Email Contacts](email-contacts.md). -- Add or remove sharing relationships and sharing settings: see [Sharing Permissions](sharing-permissions.md). +Users with the Operations role can perform most of the same actions as Admin users. However, they cannot add, modify, or remove team members. Instead, they have read-only access to the **Manage Team Members** page. + +User Roles can only be modified by users with the Admin role, by following: [Edit Information for a Team Member](#edit-information-for-a-team-member). ## Add a Team Member @@ -37,11 +37,15 @@ To add a team member, complete the following steps: 1. Log in to your UID2 Portal account. 1. At the top right, click the down arrow and choose **Manage Team Members**. 1. Click **Add Team Member**. -1. Enter the first name, last name, email, and job function. +1. Enter the first name, last name, email, job function and role. 1. Click **Save Team Member**. The team member is added to the list, with Pending status, and an invitation email is sent to the invited person. +:::note +Team members can be added to more than one participant. Team members that belong to multiple participants are able to switch between participants as shown in [UID2 Portal Structure](portal-overview.md#uid2-portal-structure). +::: + ## Resend an Invitation to a Team Member If you added a team member, you might need to resend the invitation. For example, perhaps the team member didn't receive the invitation or accidentally deleted it, or the invitation has expired. @@ -56,7 +60,7 @@ To re-send the invitation for a team member, complete the following steps: ## Edit Information for a Team Member -You can update any of the values: First Name, Last Name, Email, or Job Function. +Admin users can update any of the values: First Name, Last Name, Email, Job Function, or Role. To edit information for a team member, complete the following steps: diff --git a/sidebars.js b/sidebars.js index d3884ce11..088bdfea2 100644 --- a/sidebars.js +++ b/sidebars.js @@ -66,6 +66,7 @@ const fullSidebar = [ 'portal/participant-info', 'portal/team-members', 'portal/email-contacts', + 'portal/audit-trail', ], },