Overview

Janrain’s Customer Care Portal (CCP) is a tool that gives customer representatives scoped access to add, edit, and delete end-user profiles.

CCP Agent Management

Agent Roles

Access is granted to any user who holds one of the following roles:

  • Administrator
  • Janrain Console Agent
  • Janrain Console Agent Manager

All of these roles can be granted in the Registration Dashboard by another Administrator or by Janrain. The Console Agent Manager and Console Agent roles can also be granted from within the CCP Manage Agents section.

Role Definitions Administrator Janrain Console Agent Manager Janrain Console Agent
Search for profiles in CCP Yes Yes Yes
View profiles in CCP Yes Yes Yes
Create and edit profiles in CCP Yes Yes Yes
Read audits for a specific profile in CCP Yes Yes Yes
Search for agents in CCP Yes Yes No
Read audits for an entire application in CCP Yes Yes No
Create and edit agents in CCP Yes Yes No
View agents in CCP Yes Yes No
Administer users in the Profile Database dashboard Yes No No
Access the full profile for an entire application in CCP Yes No No

Access Levels

Agent access levels allow you to define what user profiles Agents and Agent Managers are allowed to manage in CCP. Access levels may be configured per entity type with one of the options below. By default, Agents and Agent Managers have full access to all entity types.

Access Level Description
Full Access Allows access to all user records within the selected entity type.
Blocked Allows no access to all user records within the selected entity type.
Only Allowed For Allows access only to user records within the selected entity type that match the value(s) selected in the Distinguisher values menu. This option is displayed only if you have configured a distinguisher field and values in your application settings. See below for more information.

Restricting Agent Access by Profile Data

Agent access to user records within an entity type can be restricted based on a specific distinguisher field and allowable values configured in your application settings. A distinguisher field determines the schema attribute in the profile that will be used to determine whether an agent has access to a profile. Distinguisher values are the options that can be selected for an agent to limit which user records they are able to see.

Distinguisher fields and values are set per entity type in the API client settings. The user_distinguisher_field and user_distinguisher_field_values settings are entity type-specific settings and must both be in place to enable this option.

For example, to restrict agent access to profiles in the user entity type based on country of registration, you would create two settings:

  • The user_distinguisher_field key with a value primaryAddress.country (the schema attribute in the user entity type that stores country).
  • The user_distinguisher_field_values key with a value of ["AU", "CA", "DE", "FR", "IT", "ES", "UK"] (include the full list of country codes that are stored in your user profiles that you wish to allow agents to access).

The distinguisher values setting will render a list of acceptable values from which to choose when assigning an agent the Only Allowed For access level. Multiple values may be selected for an agent.

Agent Creation and Authentication

Creating an Agent

  1. Navigate to CCP and sign in.
  2. Expand the sidenav menu if it is collapsed.
  3. Click the down arrow next to the application to which you are granting access to expand the drop-down menu.
  4. Select Manage Agents.
  5. Click the orange Create Agent button.
  6. Enter the the agent’s email address.
  7. Select the appropriate Role from the radio button list.
  8. For each entity type, select an access level.
  9. Click Save.

Registering as an Agent

  1. After an agent is created, the invited user will receive an email containing instructions to gain access to CCP. The agent should click the link embedded in the email to navigate to CCP.
  2. CCP will check if there is an account associated with the email address. If none exists, the agent must register a new account using social login or email and password.
  3. To register through social login, sign in to the authenticator with an account that uses the email address that received the invitation to CCP.
  4. To register using an email and password:
    1. Select Create Account.
    2. Fill out the required information.
    3. You must use the same email address that received the invitation to CCP.
  5. After registering, you will be confirmed as an agent.

Managing Profiles

Viewing the Profile List

To access a profile, sign in to the console. Applications are organized by region, which can be selected using the region list under the user’s profile in the upper-right corner. The selected region will be remembered on subsequent visits on the same browser. Otherwise, the user will be directed to the first region with application data.

All applications for which a user is either an Administrator, Console Agent Manager, or Console Agent are visible on the left-hand navigation. If there are no applications for a given region, the user will see a message that indicates no applications are available, and directs the user to select a different region.

Expanding the menu options for the application displays all of the entity types associated with the application to which the user has been granted access. Click on an entity type to see the list of profiles in the profile search page.

Setting Profile Display Columns

The columns that are available for display can be altered by modifying the API Client Settings in the Registration Dashboard. Add the field to the list of comma-separated values in the user_search_display_fields setting to set the order and value for the columns displayed.

Note: This is an entity type-specific setting.

Searching for Profiles

To search for a particular profile, enter the search criteria into the search box at the top of the displayed user profiles.

Setting Profile Search Fields

Any search field indexed by Janrain can be added to the default search list. To add a field to the search list, add it to the API Client Settings as the value for user_search_query_fields.

Note: This is an entity type-specific setting.

For values that are not already indexed by Janrain, ask Janrain (via a Support ticket) to add the field to the search index before adding the value to the search field list.

Once the additional fields are added, they will be searched by default from the main search page.

The following search options are available from the main search window:

  • Single- and multiple-character wildcard searches within single terms (not within phrase queries).

  • A single-character wildcard search using the ? symbol.

    The single-character wildcard search looks for terms that match with a single character replaced. For example, to search for “text” or “test”, the search query is “Te?t”.

  • A multiple-character wildcard search using the \* symbol.

    Multiple-character wildcard searches look for 0 or more characters. For example, to search for “test”, “tests”, or “tester”, the search query is “test*”.

Note: You can also use a wildcard search in the middle of a term (for example, “te*t”).

To use the advanced search option, click the Advanced Search link on the profile list page. The options available for advanced searching are Search Terms and Filters.

Search Terms

These are general search terms that the user searches on. You can choose one or more search terms.

To add a search term to the query, enter the term and press Enter.

To remove the term from the search query list, click the garbage can icon.

Filters

Filters are a list of all indexed fields available for the entity type.

To add a filter, select the field name from the filter list. (This adds the filter to the search terms list.) Any value added to this filter searches against that field only.

In addition to searching for a specific value, filters also permit searching by range. To show the range option, click the Range text on the right side of the filter value.

Range searches are permitted on any field type. For text fields, the range searches alphabetically with the first value as the start value and the second value as the end of the alphabetic range.

Multiple filters and search terms can be added together to create a complex search query.

Creating Profiles

To create a new profile, click Create Profile on the profile search page.

The profile creation page allows you to select any client properties with the login_client feature set. The property determines which flow should be used to generate the profile card (including fields, validation, and business logic).

Once the property form has loaded, the required fields are displayed with an asterisk. Fill out any necessary fields and click Save in the lower right to save the profile.

Editing Profiles

To edit a profile, click on the profile from the profile search page. This displays the edit profile form associated with a particular user’s property.

Note: The right side of the profile contains metadata and functionality to assist with troubleshooting (including reset password and email validation buttons), as well as a list of any social providers and properties with which the user has logged in.

Summary of CCP Settings

API Client Settings

These can be set either as Default Settings or per API client:

Setting Fallback Setting Default Value Fallback Value
ccp_edit_form ccp_editProfileForm editProfileForm
ccp_flow_locale default_flow_locale en-US
ccp_flow_name default_flow_name standard
ccp_flow_version default_flow_version HEAD
ccp_recover_password_form forgotPasswordForm
ccp_registration_form ccp_registrationForm registrationForm
ccp_verify_email_form resendVerificationForm
password_recover_url
verify_email_url

Entity Type-specific Default Settings

CCP uses a number of settings that are specific to an entity type. The entity type is part of the setting name. For example, the distinguisher field setting for the user entity type is user_distinguisher_field. These can only be set in the Default Settings.

Setting Fallback Value
{entity_type}_distinguisher_field
{entity_type}_distinguisher_field_values
{entity_type}_search_display_fields Default Search Display Attributes
{entity_type}_search_query_fields Default Search Query Attributes

Default Search Display Attributes

[
  {
    "name": "givenName",
    "title": "First Name"
  },
  {
    "name": "familyName",
    "title": "Last Name"
  },
  {
    "name": "email",
    "title": "Email"
  },
  {
    "name": "primaryAddress.phone",
    "title": "Phone"
  },
  {
    "name": "birthday",
    "title": "Birthday"
  },
  {
    "name": "created",
    "title": "Created"
  }
]

Default Search Query Attributes

[
  "created",
  "displayName",
  "email",
  "lastUpdated"
]
Scroll ↓