Search...

Out of support

Search...

Out of support

Introduction

Accessing the Network section

Preconditions

  • The user has access to the Workspace section.

  • The Network section is enabled for the user's profile.

Steps

  1. Navigate to Workspace from the main menu.

  2. Click Network in the sidebar. The IP Address sub-section opens by default.

  3. Use the second-level bar to switch between the IP Address and List sub-sections.

Post-conditions

  • The user can view the IP addresses and lists configured on the tenant.

Tips

  • Different types of users can see and perform different actions in the Platform. The availability of the Network section, the filters and the table columns can be configured in real time in the administration panel (see Access Management), based on contract details and/or the customer's preferences.

Consulting the IP addresses

Preconditions

  • The user is in Workspace > Network > IP Address.

Steps

  1. Consult the table. It shows one row for each pair of address and list: the same address appears more than once if it belongs to more than one list. The available columns are:

    • IP address

    • List

    • IP version

    • Subscriptions

    • Last update

    • Status

  2. Use Manage columns to choose which columns to display.

  3. Use the search bar to filter by address (partial match is supported). Click the X to clear the search.

  4. Open Filters to filter by:

    • Status (Proposed, Approved, Rejected and their sub-states)

    • List

    • IP version (IPv4, IPv6)

  5. Sort the table by IP address, IP version, Subscriptions, Last update or Status, from the column headers or from the sort control of the search bar.

Post-conditions

  • The user can locate specific IP addresses based on the applied search, filters and sorting.

Tips

  • The Status badge shows the current sub-state (e.g., Approving). The tooltip shows the complete status (e.g., Proposed, Approving).

  • Selecting a macro-state in the Status filter includes all its sub-states.

  • Options selected in the same filter are combined in OR; different filters are combined in AND.

  • The column choice made with Manage columns is kept when you return to the page.

  • If no address matches the search, the message No results is displayed.

Adding an IP address

Preconditions

  • The user's role grants the Add action on the IP Address entity.

Steps

  1. Navigate to Workspace > Network > IP Address.

  2. Click Add IP address.

  3. In Lists, select one or more lists. At least one list is mandatory.

  4. In IP name, enter the IP address.

  5. Click Save.

Post-conditions

  • The message "IP address added successfully!" is displayed.

  • The address appears in the list in status Proposed, with one row for each selected list.

Tips

  • The address must comply with the policies configured on the selected lists. An invalid address blocks the save.

  • An address already present in one of the selected lists is not an error and does not generate duplicates.

  • The Add IP address button is also available in the detail of a list.

  • If the user's role does not grant the Add action, the Add IP address button is not displayed.

Viewing IP address details

Preconditions

  • The user is in Workspace > Network > IP Address, or in the detail of a list.

Steps

  1. Click an IP address. The detail shows the address as title, the breadcrumb Network → IP Address → [address] and the tabs Data, Usage and History.

  2. In the Data tab, consult:

    • the Overview card: Address, Type (IPv4/IPv6), Subscriptions, Created, Updated;

    • the List card: one row for each list the address belongs to, with the status of the address on that list.

  3. On a row with linked subscriptions, click View requests to display the subscriptions (App, API, Version, Environment, Date, Organization). Click Hide requests to close them.

  4. In the Usage tab, consult the subscriptions currently using the IP address: App name, API, Version, Environment, List, Organization, Request date.

  5. In the History tab, consult the events in chronological order, with action, the user who performed the action, list, resulting status and date. Click View comments to read the comment entered for each event.

Post-conditions

  • The user can inspect all the details of the selected IP address.

Tips

  • When the detail is opened from a list, the breadcrumb includes the list of origin.

  • The Subscriptions link in the Overview card opens the Usage tab.

  • If at least one row is awaiting a decision, the Pending Requests alert is displayed.

  • The List column of the Usage tab shows the list through which each subscription is authorized.

Approving, rejecting and retrying an IP address

Preconditions

  • The user's role grants the corresponding action on the IP Address entity.

Steps

  1. Open the detail of the IP address.

  2. In the List card, click Approve, Reject or Retry on the row of the list concerned.

  3. In the confirmation dialog, enter a comment if required and confirm.

Post-conditions

  • The status of the address on that list is updated.

  • The action is recorded in the History tab of the address and in the History of the list.

  • The corresponding notifications are sent.

Tips

  • Each row shows only the actions available for that address on that list.

  • Reject on an address in Proposed moves it to Rejected. On an address in Approved it moves it to Rejecting and then to Rejected: the address exits the list and the traffic is no longer authorized.

  • Retry is available on addresses in Approving error or Rejecting error and resumes the interrupted transition.

  • If the operation fails, the message "An error has been encountered: the list could not be updated." is displayed and the status remains in error.

  • The subscriptions that declared a rejected address remain visible in the Usage tab, with status Unauthorized.

Deleting an IP address

Preconditions

  • All the memberships of the address are Rejected.

  • No subscription is requesting the address.

Steps

  1. Open the detail of the IP address.

  2. Click Delete IP in the bottom action bar.

  3. Confirm the action.

Post-conditions

  • The message "IP address deleted successfully!" is displayed and the user returns to the list.

  • The address is no longer present in the registry.

Tips

  • While the address is still authorized or under review on at least one list, Delete IP is disabled with the tooltip "An IP address still authorized on a list can't be deleted."

  • If the operation fails, the message "An error has been encountered: the IP address could not be deleted." is displayed.

Consulting the lists

Preconditions

  • The user is in Workspace > Network.

Steps

  1. Select the List sub-section. The table shows the columns List, Type, Active, Under review and Unauthorized.

  2. Use the search bar to filter the lists.

  3. Click a list to open its detail, with the tabs List and History.

  4. In the List tab, consult the addresses of that list. Search, filters and sorting work as in the IP Address sub-section, confined to the list.

  5. In the History tab, consult the events of all the addresses of the list.

Post-conditions

  • The user can inspect the addresses and the history of each list.

Tips

  • The Active, Under review and Unauthorized counters show the number of addresses of the list in each status.

  • Unlike the history of a single address, the History of a list shows the address on each event.

  • Lists are configured by the platform operators. If no list is configured, the message "No list has been configured on this tenant yet." is displayed.

  • Network

  • Subscriptions management

  • Access Management

Documentation menu

Introduction

Table of Contents

Accessing the Network section

Preconditions

  • The user has access to the Workspace section.

  • The Network section is enabled for the user's profile.

Steps

  1. Navigate to Workspace from the main menu.

  2. Click Network in the sidebar. The IP Address sub-section opens by default.

  3. Use the second-level bar to switch between the IP Address and List sub-sections.

Post-conditions

  • The user can view the IP addresses and lists configured on the tenant.

Tips

  • Different types of users can see and perform different actions in the Platform. The availability of the Network section, the filters and the table columns can be configured in real time in the administration panel (see Access Management), based on contract details and/or the customer's preferences.

Consulting the IP addresses

Preconditions

  • The user is in Workspace > Network > IP Address.

Steps

  1. Consult the table. It shows one row for each pair of address and list: the same address appears more than once if it belongs to more than one list. The available columns are:

    • IP address

    • List

    • IP version

    • Subscriptions

    • Last update

    • Status

  2. Use Manage columns to choose which columns to display.

  3. Use the search bar to filter by address (partial match is supported). Click the X to clear the search.

  4. Open Filters to filter by:

    • Status (Proposed, Approved, Rejected and their sub-states)

    • List

    • IP version (IPv4, IPv6)

  5. Sort the table by IP address, IP version, Subscriptions, Last update or Status, from the column headers or from the sort control of the search bar.

Post-conditions

  • The user can locate specific IP addresses based on the applied search, filters and sorting.

Tips

  • The Status badge shows the current sub-state (e.g., Approving). The tooltip shows the complete status (e.g., Proposed, Approving).

  • Selecting a macro-state in the Status filter includes all its sub-states.

  • Options selected in the same filter are combined in OR; different filters are combined in AND.

  • The column choice made with Manage columns is kept when you return to the page.

  • If no address matches the search, the message No results is displayed.

Adding an IP address

Preconditions

  • The user's role grants the Add action on the IP Address entity.

Steps

  1. Navigate to Workspace > Network > IP Address.

  2. Click Add IP address.

  3. In Lists, select one or more lists. At least one list is mandatory.

  4. In IP name, enter the IP address.

  5. Click Save.

Post-conditions

  • The message "IP address added successfully!" is displayed.

  • The address appears in the list in status Proposed, with one row for each selected list.

Tips

  • The address must comply with the policies configured on the selected lists. An invalid address blocks the save.

  • An address already present in one of the selected lists is not an error and does not generate duplicates.

  • The Add IP address button is also available in the detail of a list.

  • If the user's role does not grant the Add action, the Add IP address button is not displayed.

Viewing IP address details

Preconditions

  • The user is in Workspace > Network > IP Address, or in the detail of a list.

Steps

  1. Click an IP address. The detail shows the address as title, the breadcrumb Network → IP Address → [address] and the tabs Data, Usage and History.

  2. In the Data tab, consult:

    • the Overview card: Address, Type (IPv4/IPv6), Subscriptions, Created, Updated;

    • the List card: one row for each list the address belongs to, with the status of the address on that list.

  3. On a row with linked subscriptions, click View requests to display the subscriptions (App, API, Version, Environment, Date, Organization). Click Hide requests to close them.

  4. In the Usage tab, consult the subscriptions currently using the IP address: App name, API, Version, Environment, List, Organization, Request date.

  5. In the History tab, consult the events in chronological order, with action, the user who performed the action, list, resulting status and date. Click View comments to read the comment entered for each event.

Post-conditions

  • The user can inspect all the details of the selected IP address.

Tips

  • When the detail is opened from a list, the breadcrumb includes the list of origin.

  • The Subscriptions link in the Overview card opens the Usage tab.

  • If at least one row is awaiting a decision, the Pending Requests alert is displayed.

  • The List column of the Usage tab shows the list through which each subscription is authorized.

Approving, rejecting and retrying an IP address

Preconditions

  • The user's role grants the corresponding action on the IP Address entity.

Steps

  1. Open the detail of the IP address.

  2. In the List card, click Approve, Reject or Retry on the row of the list concerned.

  3. In the confirmation dialog, enter a comment if required and confirm.

Post-conditions

  • The status of the address on that list is updated.

  • The action is recorded in the History tab of the address and in the History of the list.

  • The corresponding notifications are sent.

Tips

  • Each row shows only the actions available for that address on that list.

  • Reject on an address in Proposed moves it to Rejected. On an address in Approved it moves it to Rejecting and then to Rejected: the address exits the list and the traffic is no longer authorized.

  • Retry is available on addresses in Approving error or Rejecting error and resumes the interrupted transition.

  • If the operation fails, the message "An error has been encountered: the list could not be updated." is displayed and the status remains in error.

  • The subscriptions that declared a rejected address remain visible in the Usage tab, with status Unauthorized.

Deleting an IP address

Preconditions

  • All the memberships of the address are Rejected.

  • No subscription is requesting the address.

Steps

  1. Open the detail of the IP address.

  2. Click Delete IP in the bottom action bar.

  3. Confirm the action.

Post-conditions

  • The message "IP address deleted successfully!" is displayed and the user returns to the list.

  • The address is no longer present in the registry.

Tips

  • While the address is still authorized or under review on at least one list, Delete IP is disabled with the tooltip "An IP address still authorized on a list can't be deleted."

  • If the operation fails, the message "An error has been encountered: the IP address could not be deleted." is displayed.

Consulting the lists

Preconditions

  • The user is in Workspace > Network.

Steps

  1. Select the List sub-section. The table shows the columns List, Type, Active, Under review and Unauthorized.

  2. Use the search bar to filter the lists.

  3. Click a list to open its detail, with the tabs List and History.

  4. In the List tab, consult the addresses of that list. Search, filters and sorting work as in the IP Address sub-section, confined to the list.

  5. In the History tab, consult the events of all the addresses of the list.

Post-conditions

  • The user can inspect the addresses and the history of each list.

Tips

  • The Active, Under review and Unauthorized counters show the number of addresses of the list in each status.

  • Unlike the history of a single address, the History of a list shows the address on each event.

  • Lists are configured by the platform operators. If no list is configured, the message "No list has been configured on this tenant yet." is displayed.

  • Network

  • Subscriptions management

  • Access Management

Documentation menu

Introduction

Table of Contents

Accessing the Network section

Preconditions

  • The user has access to the Workspace section.

  • The Network section is enabled for the user's profile.

Steps

  1. Navigate to Workspace from the main menu.

  2. Click Network in the sidebar. The IP Address sub-section opens by default.

  3. Use the second-level bar to switch between the IP Address and List sub-sections.

Post-conditions

  • The user can view the IP addresses and lists configured on the tenant.

Tips

  • Different types of users can see and perform different actions in the Platform. The availability of the Network section, the filters and the table columns can be configured in real time in the administration panel (see Access Management), based on contract details and/or the customer's preferences.

Consulting the IP addresses

Preconditions

  • The user is in Workspace > Network > IP Address.

Steps

  1. Consult the table. It shows one row for each pair of address and list: the same address appears more than once if it belongs to more than one list. The available columns are:

    • IP address

    • List

    • IP version

    • Subscriptions

    • Last update

    • Status

  2. Use Manage columns to choose which columns to display.

  3. Use the search bar to filter by address (partial match is supported). Click the X to clear the search.

  4. Open Filters to filter by:

    • Status (Proposed, Approved, Rejected and their sub-states)

    • List

    • IP version (IPv4, IPv6)

  5. Sort the table by IP address, IP version, Subscriptions, Last update or Status, from the column headers or from the sort control of the search bar.

Post-conditions

  • The user can locate specific IP addresses based on the applied search, filters and sorting.

Tips

  • The Status badge shows the current sub-state (e.g., Approving). The tooltip shows the complete status (e.g., Proposed, Approving).

  • Selecting a macro-state in the Status filter includes all its sub-states.

  • Options selected in the same filter are combined in OR; different filters are combined in AND.

  • The column choice made with Manage columns is kept when you return to the page.

  • If no address matches the search, the message No results is displayed.

Adding an IP address

Preconditions

  • The user's role grants the Add action on the IP Address entity.

Steps

  1. Navigate to Workspace > Network > IP Address.

  2. Click Add IP address.

  3. In Lists, select one or more lists. At least one list is mandatory.

  4. In IP name, enter the IP address.

  5. Click Save.

Post-conditions

  • The message "IP address added successfully!" is displayed.

  • The address appears in the list in status Proposed, with one row for each selected list.

Tips

  • The address must comply with the policies configured on the selected lists. An invalid address blocks the save.

  • An address already present in one of the selected lists is not an error and does not generate duplicates.

  • The Add IP address button is also available in the detail of a list.

  • If the user's role does not grant the Add action, the Add IP address button is not displayed.

Viewing IP address details

Preconditions

  • The user is in Workspace > Network > IP Address, or in the detail of a list.

Steps

  1. Click an IP address. The detail shows the address as title, the breadcrumb Network → IP Address → [address] and the tabs Data, Usage and History.

  2. In the Data tab, consult:

    • the Overview card: Address, Type (IPv4/IPv6), Subscriptions, Created, Updated;

    • the List card: one row for each list the address belongs to, with the status of the address on that list.

  3. On a row with linked subscriptions, click View requests to display the subscriptions (App, API, Version, Environment, Date, Organization). Click Hide requests to close them.

  4. In the Usage tab, consult the subscriptions currently using the IP address: App name, API, Version, Environment, List, Organization, Request date.

  5. In the History tab, consult the events in chronological order, with action, the user who performed the action, list, resulting status and date. Click View comments to read the comment entered for each event.

Post-conditions

  • The user can inspect all the details of the selected IP address.

Tips

  • When the detail is opened from a list, the breadcrumb includes the list of origin.

  • The Subscriptions link in the Overview card opens the Usage tab.

  • If at least one row is awaiting a decision, the Pending Requests alert is displayed.

  • The List column of the Usage tab shows the list through which each subscription is authorized.

Approving, rejecting and retrying an IP address

Preconditions

  • The user's role grants the corresponding action on the IP Address entity.

Steps

  1. Open the detail of the IP address.

  2. In the List card, click Approve, Reject or Retry on the row of the list concerned.

  3. In the confirmation dialog, enter a comment if required and confirm.

Post-conditions

  • The status of the address on that list is updated.

  • The action is recorded in the History tab of the address and in the History of the list.

  • The corresponding notifications are sent.

Tips

  • Each row shows only the actions available for that address on that list.

  • Reject on an address in Proposed moves it to Rejected. On an address in Approved it moves it to Rejecting and then to Rejected: the address exits the list and the traffic is no longer authorized.

  • Retry is available on addresses in Approving error or Rejecting error and resumes the interrupted transition.

  • If the operation fails, the message "An error has been encountered: the list could not be updated." is displayed and the status remains in error.

  • The subscriptions that declared a rejected address remain visible in the Usage tab, with status Unauthorized.

Deleting an IP address

Preconditions

  • All the memberships of the address are Rejected.

  • No subscription is requesting the address.

Steps

  1. Open the detail of the IP address.

  2. Click Delete IP in the bottom action bar.

  3. Confirm the action.

Post-conditions

  • The message "IP address deleted successfully!" is displayed and the user returns to the list.

  • The address is no longer present in the registry.

Tips

  • While the address is still authorized or under review on at least one list, Delete IP is disabled with the tooltip "An IP address still authorized on a list can't be deleted."

  • If the operation fails, the message "An error has been encountered: the IP address could not be deleted." is displayed.

Consulting the lists

Preconditions

  • The user is in Workspace > Network.

Steps

  1. Select the List sub-section. The table shows the columns List, Type, Active, Under review and Unauthorized.

  2. Use the search bar to filter the lists.

  3. Click a list to open its detail, with the tabs List and History.

  4. In the List tab, consult the addresses of that list. Search, filters and sorting work as in the IP Address sub-section, confined to the list.

  5. In the History tab, consult the events of all the addresses of the list.

Post-conditions

  • The user can inspect the addresses and the history of each list.

Tips

  • The Active, Under review and Unauthorized counters show the number of addresses of the list in each status.

  • Unlike the history of a single address, the History of a list shows the address on each event.

  • Lists are configured by the platform operators. If no list is configured, the message "No list has been configured on this tenant yet." is displayed.

  • Network

  • Subscriptions management

  • Access Management