diff --git a/docs/portal/audit-trail.md b/docs/portal/audit-trail.md index 6026f0e2b..9837b63da 100644 --- a/docs/portal/audit-trail.md +++ b/docs/portal/audit-trail.md @@ -9,4 +9,28 @@ 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 +In the UID2 Portal, users who have the Admin role (see [User Roles](team-members.md#user-roles)) can access the **Audit Trail** page to view a detailed log of all past actions performed by or on behalf of the current sharing participant. + +The Audit Trail log displays the types of information summarized in the following table. + +| Column | Details | +| :--- | :--- | +| Date | Date/time that the action occurred. | +| User | The user who performed the action. | +| Event | The action performed. For a summary of possible values, see [Audit Trail Event Types](#audit-trail-event-types). | +| Event Data | Details about the action. | +| Succeeded | Indicates whether or not the action was successful. | + +## Audit Trail Event Types + +The audit trail log reports the following types of activity, listed in the Event column: + +- Approve Account +- Manage API Key +- Manage Key Pair +- Manage Participant +- Manage Team Members +- Update App Names +- Update Domain Names +- Update Sharing Permissions +- Update Sharing Types diff --git a/docs/portal/images/portal-team-members-resend-invitation.png b/docs/portal/images/portal-team-members-resend-invitation.png new file mode 100644 index 000000000..a1cffa611 Binary files /dev/null and b/docs/portal/images/portal-team-members-resend-invitation.png differ diff --git a/docs/portal/portal-overview.md b/docs/portal/portal-overview.md index 4d11f4673..02ce566a4 100644 --- a/docs/portal/portal-overview.md +++ b/docs/portal/portal-overview.md @@ -18,7 +18,7 @@ The UID2 Portal is your one-stop shop for setting up and configuring your UID2 a | Review your profile. | [Participant Information](participant-info.md) | | Server-side or client/server integrations: Manage API keys for your account, including adding, modifying, or deleting keys. | [API Keys](api-keys.md) | | Client-side integrations only: Set up and manage the values needed for generating UID2 tokens on the client side. | [Client-Side Integration](client-side-integration.md) | -| 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) | +| 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) | @@ -37,7 +37,11 @@ There are two main ways to access the pages, as shown in the following image: ![UID2 Portal Structure](images/portal-uid2-overview.png) -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. +The name of the current participant is displayed at the top of the left sidebar. If your account has access to multiple participants, you'll see a drop-down list of the participants that you have access to. You can use this to switch between participants. + +:::important +Any actions that you perform in the UID2 Portal, such as adding team members, domains, or API keys, are in the context of the participant currently displayed on the left. If you have access to more than one participant, make sure you perform actions in the correct context. For details, see [Participant Switcher](#participant-switcher). +::: Continuing down the left sidebar, you can access the following pages relating to configuring your account: @@ -54,9 +58,19 @@ From here, you can access the following pages relating to your personal account - [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 +- Dark Mode: Toggles dark mode on and off. Dark mode preference is applied to subsequent sessions. - [Log Out](portal-getting-started.md#log-out) ## Set Up Your Account To set up your account, see [Getting Started with the UID2 Portal](portal-getting-started.md). + +## Participant Switcher + +In most cases, each user has access to the data for one UID2 sharing participant. However, in some cases, an individual user might be on the team for more than one participant. In this scenario, the user can switch between participants. + +The current participant is displayed at the top of the left sidebar. If the current user is on the team for more than one participant, an arrow indicates that the user can switch between participants, to perform actions in the context of the correct participant. + +For an illustration, see [UID2 Portal Structure](#uid2-portal-structure). + +When the user logs out, the most recent participant choice is stored and is applied the next time the user logs in. diff --git a/docs/portal/sharing-permissions.md b/docs/portal/sharing-permissions.md index fbac9e69e..3dd7efa63 100644 --- a/docs/portal/sharing-permissions.md +++ b/docs/portal/sharing-permissions.md @@ -9,7 +9,7 @@ import Link from '@docusaurus/Link'; # Sharing Permissions -Configuring your sharing permissions opens the door to you being able to share UID2s with other UID2 participants. +Configuring your sharing permissions opens the door to you being able to share UID2s with other UID2 sharing participants. There are many options to help you create the exact sharing relationships that you want: diff --git a/docs/portal/team-members.md b/docs/portal/team-members.md index 2d4fbbd53..4819a8680 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, Admin users 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, users with the Admin role 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) @@ -20,15 +20,29 @@ In the UID2 Portal, on the **Team Members** page, Admin users can perform all ac 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). +For each team member, the following information is displayed: +- Name + + If the user has been invited but has not yet accepted, there is a **Pending** tag after the person's name. +- Email +- Job Function +- Role +- Actions: + - Available for all: ![the Edit icon](images/icon-pencil-solid.png) (Edit) and ![the Delete icon](images/icon-trash-can-solid.png) (Delete). + - If the user has been invited but has not yet accepted, a **Resend Invitation** link is also available. + +For an illustration, see [Resend an Invitation to a Team Member](#resend-an-invitation-to-a-team-member). ## User Roles -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). +Each team member has one of the roles shown in the following table. -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. +| Role | Actions | +| :--- | :--- | +| Admin | Users with the Admin role can perform all activities related to UID2 participation, as summarized in the [UID2 Portal Overview](portal-overview.md), for the current participant organization. | +| Operations | Users with the Operations role can perform most of the same actions as Admin users. However, there are some limitations: | -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). +User roles can only be modified by users with the Admin role. For details, see [Edit Information for a Team Member](#edit-information-for-a-team-member). ## Add a Team Member @@ -43,13 +57,20 @@ To add a team member, complete the following steps: 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). +Team members can be added to more than one participant. Team members who belong to multiple participants can 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. +If the user has been invited but has not yet accepted, the Team Members list includes the following additional information, as shown in the illustration: + +- A Pending label after the person's name. +- A **Resend Invitation** link. + +![UID2 Portal, Team Members page, pending user](images/portal-team-members-resend-invitation.png) + To re-send the invitation for a team member, complete the following steps: 1. Log in to your UID2 Portal account. @@ -58,16 +79,29 @@ To re-send the invitation for a team member, complete the following steps: The status updates to **Invitation Sent**, and a new invitation email is sent. +:::note +The Resend Invitation link only appears if the user has been invited, but has not yet accepted. +::: + ## Edit Information for a Team Member -Admin users can update any of the values: First Name, Last Name, Email, Job Function, or Role. +Notes re role: +- Users with the Admin role can update any of these values, for any team member in their participant organization. +- Users with the Operations role can view the Team Members page, but cannot change the information. To edit information for 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. Find the team member on the list and then, in the Actions column, click ![the Edit icon](images/icon-pencil-solid.png) (the Edit icon). -1. Update the information, and then save the changes. +1. Update any of these values: + - First Name + - Last Name + - Job Function + - Role: For information about roles, see [User Roles](#user-roles). + + **Note**: You cannot update the email for an existing team member. If you need to change the email, add a new team member using the new email. This ensures that the email verification process is correctly followed. In this scenario, remember to also delete the existing entry with the old email address. +1. Save the changes. ## Remove a Team Member