Preferred Name

Connection Params [ENV: TEST]

# -----------------------------
# PREFERRED NAME Endpoint
# -----------------------------
PREFERRED_NAME__API_KEY=[see .env on S3 Bucket]
WORKFLOW_URL__GENERATE_EMAIL=[see .env on S3 Bucket]
WORKFLOW_URL__UPDATENAME=[see .env on S3 Bucket]

Description

This Application allows users to change their Preferred Name and Email Address. The user fills out a form where they can request to change their first name, last name, or both. Whatever change they request in this form will also update their email address to [email protected] if they belong to the BPL or BPHC agencies; only their name will be updated. For users in the BPL or BPHC agencies, the app will skip the confirmation screen.

App Request Flow

1. On the Enter Name view, on submit a request is send to the node server route /preferred-name-request

2. This route constructs params needed to make request to the [PREFERRED NAME] WORKFLOW

   1. endpoint URL

   2. requestJson

   3. authorization token

3. The params are sent to requestNewNameEmail function on line 28 that will connect to the WORKFLOW and return the new name and/or email

4. IF the user belongs to the BPL or BPHC agencies

   1. The UI/UX sends the request to the /preferred-name-submit ROUTE. This route method submits a request to the WORKFLOW endpoint to change the user's name and/or display name. For these users, only their names will be requested to change. The SUCCESS/ERROR view is displayed depending on the result from the WORKFLOW.

5. ELSE ^ ... The App displays the next VIEW (Confirmation), used to confirm the user's changes and displays the new Email Address composed from the first / last name entered in the previous view.

6. SUBMITTING the request from the Confirmation view will send the request to the /preferred-name-submit ROUTE, the route will use step 3 (above), SUCCESS/ERROR views are displayed depending on the result from the WORKFLOW.

App Files/Resources

• Preferred Names Endpoint Information provided the Security Team

• (Node) Server

  • Routes

    • Request a new Name

      • path: services-js/access-boston/src/server/access-boston.ts

        • line: 443 Route Request Method

    • Submit new Name and/or Email Request

      • path: services-js/access-boston/src/server/access-boston.ts

        • line: 525 Route Request Method