Security

  1. Start PortX. The Transaction Monitoring Page appears.

  2. In the left-hand navigation pane, in the CONFIGURATION section, click Partners and Applications. The Partners and Applications Page appears.

img-partners-and-applications
Figure 1. Partners and Applications Page

  1. In the Administration page of the left-hand navigation pane, click Security.

    The Security Page appears.

img-security
Figure 2. Security Page

  1. On this page, you can:

Create a New API Key

The API Key is specific to an environment in PortX. Therefore, before you create a new API Key, coordinate with your organization’s PortX administrator to ensure that none of your organization’s processes are using an existing API Key because, if they are, creating a new API Key will cause existing processes to cease functioning. In that case, instead of creating a new API Key, use the existing API Key for that environment.

  1. On the Security Page, click Create a new API key.

    The API Key Warning Page appears.

img-api-key-warning
Figure 3. API Key Warning Page

  1. Read the API Key Warning Page carefully.

    If, after you have read API Key Warning Page, you are sure you want to create the key, on API Key Warning Page, click Generate.

Specify a Method for Authenticating Persisted Messages

  1. In Persisted Message Authentication Settings, click the Scheme dropdown list.
    A list of available authentication methods appears.

  2. Click the method you want to use.
    Settings specific to the method you choose appear.

  3. Enter values for the method-specific settings.
    For more information, click the method you chose:

  4. Click Save to save settings.

S3 Bucket

Name Description

Access Key ID

Type: string
Required: Yes, if this method is selected from the Scheme dropdown list.
Default: None

Security Key

Type: string
Required: Yes, if this method is selected from the Scheme dropdown list.
Default: None

Bucket Name

Type: string
Required: Yes, if this method is selected from the Scheme dropdown list.
Default: None

Region

Type: string
Required: Yes, if this method is selected from the Scheme dropdown list.
Default: None

Basic Auth

Name Description

Username

Type: string
Required: Yes, if this method is selected from the Scheme dropdown list.
Default: None

Password

Type: string
Required: Yes, if this method is selected from the Scheme dropdown list.
Default: None

ClientId / Secret

Name Description

ClientId

Type: string
Required: Yes, if this method is selected from the Scheme dropdown list.
Default: None

Secret

Type: string
Required: Yes, if this method is selected from the Scheme dropdown list.
Default: None

API Key

Name Description

API Key

Type: string
Required: Yes, if this method is selected from the Scheme dropdown list.
Default: None

Http Header

Type: string
Required: No
Default: None

PingFederate OAuth - Client Credentials

Name Description

Token Url

Type: string
Required: Yes, if this method is selected from the Scheme dropdown list.
Default: None

Client ID

Type: string
Required: Yes, if this method is selected from the Scheme dropdown list.
Default: None

Client Secret

Type: string
Required: Yes, if this method is selected from the Scheme dropdown list.
Default: None