Request additional endpoints

Overview

Purpose

To enable the addition of find, view and PAT refresh endpoints.

Who completes this step?

• primary business contact

Read the full list of roles and responsibilities.

Before you begin

Ensure that you have the necessary endpoint information that you would like to add. You need to prepare:

• a brief explanation of the reason for your request (for more information see information about scale of change below)
• identify the scale of change for the request (minor, moderate or significant)
• the URLs for the endpoints you are adding
• evidence of your internal IT service acceptance

Information about scale of change

The scale of change refers to the change that adding the endpoint represents. Depending on the scale of change, different levels of testing and evidence are required before the endpoint can be added to the ecosystem.

Minor change

For minor changes, no additional test evidence is needed. This category may include scenarios where additional endpoints are based on the same hosting, platform and technology stack as the current endpoints that have been added.

Moderate change

This category may include scenarios where your solution is re-platformed, for example if you move from an Infrastructure-as-a-service model to a Platform/Function as a service model. It may also include changes in the technology stack. For example, if you change from a Windows solution to a Linux solution or change from .Net to Java.

Significant change

This category may include scenarios where your solution is migrated to a new hosting or cloud provider. For example, if the solution was moved from on-premises to AWS, Azure or GCP.

What you need to do in this step

1. On the connection portal, navigate to the ‘Endpoints’ tab and click ‘Add live endpoints’.
2. Read the ’Add additional endpoints’ page to ensure that you have all the relevant information to hand to complete the form.
3. Enter in a reason for your request. This should describe details of the change you’re making that has resulted in the addition of a new endpoint.
4. Select your ‘scale of change’ category based on the descriptions and examples provided above.
5. Select the endpoint type from the drop-down list: Find, View or PAT refresh.
6. Enter your endpoint URL (which cannot end with a trailing backslash, “/”).
7. Upload evidence of internal IT service acceptance. This may be a screenshot of your service acceptance from your service management tool. The file must be 25MB or less and be in a JPEG, PNG or PDF format.
8. Check your answers. You can review and change all the details that you have provided above.
9. Once you are satisfied with your answers, click ‘Confirm and submit’.

You can only add one endpoint during the process. To add more endpoints, you will need to repeat the process.

What happens next

You will receive email confirmation of your submission.

Your request will be reviewed by PDP, where the scale of change you have selected will be assessed based on the reason for your request. You will then receive email confirmation of the scale of change that will determine what testing evidence needs to be supplied.

Minor changes

Your request to add new endpoints will be reviewed by our test manager. You will be notified by email of the outcome of this review. If the scale of change description doesn’t match the 'minor change' criteria, then our test manager may suggest another category.

Moderate and significant changes

Your test manager will be asked to provide evidence of system testing via the prerequisites process. You will be required to follow the steps below:

1. Test manager completes prerequisites process.

2. Primary technical contact downloads, deploys and confirms deployment of test cryptographic material.

3. PDP implementation manager will arrange integration testing with your test manager.

4. Security lead completes IT health check process (significant changes only).

5. Test manager submits integration testing report.

6. Service manager completes service acceptance process.

7. PDP change and release manager reviews addition of endpoints submission, you will be notified of the outcome. Once approved, the endpoint will be live pending deployment of live crypto materials.

8. Primary technical contact is notified that they can download and deploy cryptographic material for the new live endpoints.

Once approved, you will be able to associate pension providers and schemes with the endpoints added.

Support