Administration
This section describes how to create and manage partner, customer, and user accounts, and cloud resources.
Manage Onyx Portal Accounts
The Onyx Portal supports the following account types:
GXC Root Account – The root account comprising of all GXC partner (and associated customer accounts) and GXC-direct customer accounts. You can switch to and manage the GXC Root account only if you are a GXC Administrator.
GXC Partner Accounts – System Integrator (SI) or Value-added Reseller (VAR) accounts comprising associated customer accounts. If you are a Partner Administrator, you can switch to and manage your own GXC partner account. If you are a GXC Administrator, you can switch to and manage any GXC partner account.
Customer Accounts – Individual customer accounts. If you are a Partner Administrator, you can switch to and manage your own customer accounts. If you are a GXC Administrator, you can switch to and manage any customer account.
Support Plans
Support plans are assigned to each GXC partner and customer account outline the level of assistance and services available, including technical support hours, response times, resolution times, and access to resources such as support documentation and training materials.
Basic – GXC provides business hours support for Tier 3 issues.
Basic Plus – (Additional subscription) GXC provides NOC monitoring, and Tier 1 / 2 / 3 Support 24 x 7 x 365 with standard response times for a cost-effective solution.
Platinum – (Additional subscription) Includes "Basic Plus" features with accelerated SLA response and resolution times.
Partner Managed – GXC Partner / Customer integrates GXC Onyx to their own NOC to directly manage Tier 1 / 2 issues.
For more information regarding the entitlements associated with each of these support plans, please contact your GXC Account representative or GXC Technical Support.
Manage GXC Partner Accounts
View GXC Partner Accounts
This section describes how to:
View Summary Details of All GXC Partner Accounts
View a GXC Partner Account's Details
View Summary Details of All GXC Partner Accounts
To view the summary details of all GXC partner accounts:
Switch to the GXC Root account.
To switch to the GXC Root account, in the upper-right corner of the page, click the current Onyx Portal account's name, then click Other Accounts > Select GXC Root.
In the navigation pane, click Administration > Partners tab.
The Administration page > Partners tab displays the summary details of all GXC partner accounts.
Name – The GXC partner account's name.
Email – The GXC partner account's email address.
Support Plan – The support plan assigned to the GXC partner account—Basic, Basic Plus, Platinum, and Partner Managed. For more information, see Support Plans.
Actions – (Super Administrator only) Options to view, edit, and delete the GXC partner account.
To download a CSV file listing the partner accounts' details including partner name, GXC support plan, contact email ID, and address, click Download. The CSV file is downloaded to your computer.
To search for a particular GXC partner account, in the Search box, enter your search term.
View a GXC Partner Account's Details
To view a GXC partner account's details:
Switch to the GXC Root account.
To switch to the GXC Root account, in the upper-right corner of the page, click the current Onyx Portal account's name, then click Other Accounts > Select GXC Root.
In the navigation pane, click Administration > Partners tab.
The Administration page > Partners tab displays the summary details of all GXC partner accounts.
To view the details of a particular GXC partner account, click the account's name.
The <partner name> page displays the GXC partner account's details:
Partner Details:
E-mail – The Account Manager's email address.
Type – The account's type—GXC Partner.
Parent – The GXC partner account's parent—GXC Root.
Name – The GXC partner account's name.
Address – The GXC partner account's registered address.
Session Timeout – The Onyx Portal user session timeout duration for users in this GXC partner account. If a user's session is idle for this duration, the user is automatically logged out.
Support Plan – The support plan assigned to the GXC partner account—Basic, Basic Plus, Platinum, and Partner Managed. For more information, see Support Plans.
Customers – List of customer accounts under this GXC partner account.
Name – The customer account's name.
E-mail – The customer's email address.
Type – The customer account type—Customer.
Customer ID – The customer account's ID.
Actions – Options to view and delete the customer account.
Own Users – List of the GXC partner account's own users.
Name – The user's name.
E-mail – The user's email address.
Role – The user's role.
User ID – The user's ID.
Actions – Options to edit and delete the user account.
Account Managers – List of the GXC partner account's Account Managers.
Name – The user's name.
E-mail – The user's email address.
Role – The user's role.
User ID – The user's ID.
Add Super Admin User Account under a GXC Partner Account
To add a Super Admin user account under a GXC partner account:
Switch to the GXC Root account.
To switch to the GXC Root account, in the upper-right corner of the page, click the current Onyx Portal account's name, then click Other Accounts > Select GXC Root.
In the navigation pane, click Administration > Partners tab.
The Administration page > Partners tab displays the summary details of all GXC partner accounts.
For the GXC partner account that you want to edit, in the Actions column, click the corresponding ⋮ (options) icon, then click View.
The <partner name> page displays the GXC partner account's details.
To add a Super Admin user account to the GXC partner account, in the Own Users section, click Add User.
The Create User page is displayed.
Enter the following details:
Upstream IdP User – If a customer's IdP cannot release user attributes such as "onyxPortalTenantId", "onyxPortalRole", etc. required for SSO user authentication to the Onyx IdP, user accounts for Onyx Portal users in the customer's organization are created in the Onyx Portal. To enable SSO authentication for such users, this toggle button must be enabled to fetch the required attributes from the user's Onyx Portal account settings. Default setting: disabled.
User Email – (Required) The user's email address.
User Name – (Required) The user account's user name.
Role – (View-only field) The user's role—Super Admin.
To save the user account, in the upper-right corner of the page, click Save User.
Manage Customer Accounts
View Customer Accounts
This section describes how to:
View Summary Details of All Customer Accounts
View a Customer Account's Details
View Summary Details of All Customer Accounts
To view the summary details of all customer accounts:
Switch to the GXC Root account.
To switch to the GXC Root account, in the upper-right corner of the page, click the current Onyx Portal account's name, then click Other Accounts > Select GXC Root.
In the navigation pane, click Administration > Customers tab.
The Administration page > Customers tab displays the summary details of all Onyx Portal customer accounts. All customer accounts irrespective of their partner hierarchy are listed in the Customers tab.
Customer Name – The customer account's name.
GXC Partner – If the customer account is associated with a GXC partner, the GXC partner's name.
Email – The Account Manager's email address.
Support Plan – The support plan assigned to the customer account—Basic, Basic Plus, Platinum, or Partner Managed. For more information, see Support Plans.
Actions – Options to view details, edit and delete a GXC partner account.
To download a CSV file listing the associated customer accounts with details including customer name, partner, GXC support plan, contact email ID, and address, click Download. The CSV file is downloaded to your computer.
To search for a customer account, in the Search box, enter your search term.
View a Customer Account's Details
To view a customer account's details:
Switch to the GXC Root account.
To switch to the GXC Root account, in the upper-right corner of the page, click the current Onyx Portal account's name, then click Other Accounts > Select GXC Root.
In the navigation pane, click Administration > Customers tab.
The Administration page > Customers tab displays the summary details of all Onyx Portal customer accounts. All customer accounts irrespective of their partner hierarchy are listed in the Customers tab.
To view the details of a particular customer account, click the customer account's name.
The <customer name> page displays the following details:
Customer Details:
E-mail – The Account Manager's email address. The email address of the customer account's first Super Administrator user. This Super Administrator user will have the privilege to create other user accounts within the customer account.
Type – The account type—Customer.
GXC Partner – If the customer account is associated with a GXC partner, the GXC partner's name.
Name – The customer account's name.
Address – The customer's registered address.
Session Timeout – The Onyx Portal user session timeout duration for users in this customer account. If a user's session is idle for this duration, the user is automatically logged out.
Support Plan – The support plan assigned to the customer account—Basic, Basic Plus, Platinum, and Partner Managed. For more information, see Support Plans.
Add SSO Config – (Displayed only if SSO is not configured.) Click to add SSO configuration for the customer account. For more information, see Add SSO with IdP Configuration.
Edit SSO Config – (Displayed only if SSO is already configured.) Click to edit SSO configuration for the customer account. For more information, see Edit SSO with IdP Configuration.
Account ID – The Onyx Portal cloud account ID.
Resource Group ID – The resource group's ID.
Resource Group Name – The resource group's name.
Region – The region associated with the resource group.
Availability Zone – The availability zone associated with the resource group.
Status – The resource group's status—Create Complete, etc.
Host Key – Options to view and download the host key.
Click the expand icon to view EC2 instances, if provisioned.
Instance ID – The instance's ID.
Instance Name – The instance's name.
Connected Onyx Edge – The connected Onyx Edge's name.
Network Name – The network's name.
Private IP – The instance's private IP address.
Public IP – The instance's public IP address.
Status – The instance's provisioning status.
Green – Create Complete
Red – Rollback Complete
– Click to delete the instance.
Add Resource Group – Click to create a cloud resource group. For more information, see Create Cloud Resource Groups.
Own Users:
Name – The user's name.
E-mail – The user's email address.
Role – The user's role.
User ID – The user's user ID.
Actions – Options to edit and delete the user account.
Account Managers: This section is not applicable in this release.
Add User – Click to add a user account under the customer account. For more information, see Create User Accounts under a Customer Account.
Create User Accounts under a Customer Account
To add a user to a customer account:
Switch to the GXC Root account.
To switch to the GXC Root account, in the upper-right corner of the page, click the current Onyx Portal account's name, then click Other Accounts > Select GXC Root.
In the navigation pane, click Administration > Customers tab.
The Administration page > Customers tab displays the summary details of all Onyx Portal customer accounts.
For the customer account that you want to add the user to, in the Actions column, click the corresponding ⋮ (options) icon, then click View.
The <customer name> page displays the customer account's details.
In the Account Managers section, click Add User.
The Create User page is displayed.
Enter the following details:
User Email – (Required) The user's email address.
User Type – (View-only field) The user's account type—Own User.
User Name – (Required) The user's account name.
Role – (Required) The user's role. Select from Super Admin, Admin, Viewer.
Upstream IdP User – (Optional) If a customer's IdP cannot release user attributes such as "onyxPortalTenantId", "onyxPortalRole", etc. required for SSO user authentication to the Onyx IdP, user accounts for Onyx Portal users in the customer's organization are created in the Onyx Portal. To enable SSO authentication for such users, this toggle button must be enabled to fetch the required attributes from the user's Onyx Portal account settings. Default setting: disabled.
To save the user account, in the upper-right corner of the page, click Save User.
Configure SSO Authentication with IdP Configuration
The Onyx Portal can integrate with a customer organization's existing IdP for SSO user authentication. The customer must provide their IdP details to GXC for integration with the Onyx Portal.
All IdP-related configurations such as entity ID, IdP metadata, Single Sign-On/Single Logout URLs and certificates are configured in the Onyx IdP. The Single Sign-On and Single Logout requests are redirected from the Onyx Portal to the Onyx IdP. The Onyx IdP does the target IdP discovery based on the RequestedAuthnContext in the SAML Authentication Request and redirects the Single Sign-On/Logout request to the customer IdP.
Add SSO with IdP Configuration
To add SSO configuration for an existing Onyx Portal customer account:
Switch to the GXC Root account.
To switch to the GXC Root account, in the upper-right corner of the page, click the current Onyx Portal account's name, then click Other Accounts > Select GXC Root.
In the navigation pane, click Administration > Customers tab.
The Administration page > Customers tab displays the summary details of all Onyx Portal customer accounts.
In the upper-right corner of the Customer Details panel, click Add SSO Config.
The Add SSO Config dialog box is displayed.
Enter the following details:
Enable SSO – Toggle to enable or disable SSO for the customer account.
Organization Name – (Required) The organization's name.
IdP Entity ID – (Required) The IdP's entity ID, a unique ID for the IdP within the SSO ecosystem. It is used by service providers to recognize and trust the IdP.
IdP Destination URL – (Required) The endpoint where the IdP receives authentication requests from the service provider. This URL is used during the SSO process to authenticate users.
SSO Vendor – (Required) Select the SSO solution vendor's name—Google, Shibboleth, Okta.
IDP SLO URL – (Optional) The IDP's single logout (SLO) URL. The endpoint where the IdP handles logout requests. This URL ensures that when a user logs out from one service, the session is terminated across all connected services in the SSO environment.
IdP Metadata URL – (Required) The metadata file location for the IdP. This file contains configuration information, such as entity ID, SSO URLs, SLO URLs, and certificates, which the service provider uses to establish trust and integrate with the IdP.
+ Upload Metadata – Click to add a metadata file. In XML format, this metadata contains the necessary configurations and certificates required to establish trust between the IdP and service providers within the SSO environment.
Additional Config:
IDP Certificate – A digital certificate issued to the IdP that is used to sign authentication assertions and encrypt communications. This certificate ensures the integrity and security of the data exchanged between the IdP and the service provider. It typically contains the public key used in the cryptographic processes.
InCommon Metadata Filter – A configuration tool or setting used within the "InCommon Federation", a trusted framework for U.S. education and research institutions. This filter allows administrators to selectively include or exclude metadata from the federation's metadata aggregate based on specific criteria. This helps manage which entities are trusted and ensures that only relevant and up-to-date metadata is processed for authentication and authorization purposes.
To save the SSO config, click Save.
Edit SSO with IdP Configuration
To edit the SSO configuration for an Onyx Portal customer account:
Switch to the GXC Root account.
To switch to the GXC Root account, in the upper-right corner of the page, click the current Onyx Portal account's name, then click Other Accounts > Select GXC Root.
In the navigation pane, click Administration > Customers tab.
The Administration page > Customers tab displays the summary details of all Onyx Portal customer accounts.
In the upper-right corner of the Customer Details panel, click Edit SSO Config.
The Edit SSO Config dialog box is displayed.
Update the following details as required:
Enable SSO – Toggle to enable or disable SSO for the customer account.
Organization Name – (Required) The organization's name.
IdP Entity ID – (Required) The IdP's entity ID, a unique ID for the IdP within the SSO ecosystem. It is used by service providers to recognize and trust the IdP.
IdP Destination URL – (Required) The endpoint where the IdP receives authentication requests from the service provider. This URL is used during the SSO process to authenticate users.
SSO Vendor – (Required) Select the SSO solution vendor's name—Google, Shibboleth, Okta.
IDP SLO URL – (Optional) The IDP's single logout (SLO) URL. The endpoint where the IdP handles logout requests. This URL ensures that when a user logs out from one service, the session is terminated across all connected services in the SSO environment.
IdP Metadata URL – (Required) The metadata file location for the IdP. This file contains configuration information, such as entity ID, SSO URLs, SLO URLs, and certificates, which the service provider uses to establish trust and integrate with the IdP.
+ Upload Metadata – Click to add a metadata file. In XML format, this metadata contains the necessary configurations and certificates required to establish trust between the IdP and service providers within the SSO environment.
Additional Config:
IDP Certificate – A digital certificate issued to the IdP that is used to sign authentication assertions and encrypt communications. This certificate ensures the integrity and security of the data exchanged between the IdP and the service provider. It typically contains the public key used in the cryptographic processes.
InCommon Metadata Filter – A configuration tool or setting used within the "InCommon Federation", a trusted framework for U.S. education and research institutions. This filter allows administrators to selectively include or exclude metadata from the federation's metadata aggregate based on specific criteria. This helps manage which entities are trusted and ensures that only relevant and up-to-date metadata is processed for authentication and authorization purposes.
To save your edits, click Save.
Manage Onyx Portal User Accounts
The Onyx Portal supports creating and managing user accounts for users to monitor and manage their enterprise/private networks.
User privileges are strictly regulated by Role-based Access Control (RBAC). Users, such as Support Engineers, can be granted access to only view specific data while restricting their ability to create, modify, or delete configurations.
The Onyx Portal supports the following user roles:
GXC Administrator – The highest level in the Onyx Portal user hierarchy. Can create and manage partner and customer accounts.
GXC Partner Administrator – System Integrators (SI) or Value-added Resellers (VAR). Can perform all configuration and management tasks for associated customer accounts.
Super Administrator – Can perform all configuration and management tasks within the managed network.
Administrator – Can perform equipment-level operations and management within the managed network.
Viewer – Can only monitor the managed network.
The following table summarizes user administration privileges across user roles.
The privileges indicated in the following tables follows the CRUD convention:
C – Create or add new entries.
R – Read, retrieve, search, or view existing entries.
U – Update or edit existing entries.
D – Delete, deactivate, or remove existing entries.
User Administration Privileges
GXC Administrator
Super CRUD
CRUD
CRUD
CRUD
CRUD
GXC Partner
R for associated accounts
R
CR
CRUD
CRUD
Super Administrator
R for self account
CRUD for self account
R
CRUD
CRUD
Administrator
No
R
R
R
RUD
Viewer
No
R
R
R
R
The following table summarizes Onyx Portal RBAC across user roles.
Onyx Portal Administration Privileges
Venues
Venue
CRUD
CRUD
CRUD
RU
R
Floors
CRUD
CRUD
CRUD
RU
R
Equipment
Onyx Edge
CRUD
CRUD
CRUD
CRUD
R
Onyx Edge Upgrade Groups
CRUD
CRUD
CRUD
R
R
Access Point
CRUD
CRUD
CRUD
CRUD
R
Access Point Upgrade Groups
CRUD
CRUD
CRUD
R
R
Mesh Node
CRUD
CRUD
CRUD
CRUD
R
Mesh Node Upgrade Groups
CRUD
CRUD
CRUD
R
R
FHM
CRUD
CRUD
CRUD
CRUD
R
FHM Upgrade Groups
CRUD
CRUD
CRUD
R
R
Subscribers
Subscriber Secrets
CRUD
Unauthorized
Unauthorized
Unauthorized
Unauthorized
Subscriber Info / Traffic Policy, APN Association
RU
RU
RU
RU
R
Subscriber Info - IMEI Association
RU
RU
RU
RU
R
Bulk Export / Import
CRUD
Unauthorized
Unauthorized
Unauthorized
Unauthorized
Session Monitoring
R
R
R
R
R
Network
Network
CRUD
CRUD
CRUD
R
R
Network List
CRUD
CRUD
CRUD
R
R
Traffic
Policies
CRUD
CRUD
CRUD
CRUD
R
Profiles
CRUD
CRUD
CRUD
CRUD
R
Alerts
Alerts Visibility
R
R
R
R
R
Rules
CRUD
R
R
R
R
Receivers
CRUD
CRUD
CRUD
CRU
R
Analytics
Generate Reports
R
R
R
R
R
Audit Logs
Audit Logs Visibility
R
R
R
Unauthorized
Unauthorized
Onyx Portal User Idle Session Timeout
While users inherit partner or customer account timeout settings by default, administrators can configure custom timeouts for individual users based on their roles, operational needs, or security policies.
The custom timeout setting can be configured when adding or editing a user account.
The custom timeout setting can be configured in one of the following ranges:
5–59 minutes
1–23 hours
1–7 days
For SSO user accounts, idle session timeout in Onyx Portal is independent of the SSO/SAML IdP configuration. If the Onyx Portal timeout is shorter than the IdP's, users are logged out but silently reauthenticated if the IdP session is still valid. If the Onyx Portal timeout is longer, users must fully reauthenticate once the IdP session expires.
For multi-tenant user accounts, the idle session timeout is determined by the base tenant's setting.
View User Accounts
View User Accounts under Non-GXC Root Accounts
View User Accounts under the GXC Root Account
View User Accounts under Non-GXC Root Accounts
To view user accounts under non-GXC Root accounts:
Switch to the required Onyx Portal account.
To switch between Onyx Portal accounts, in the upper-right corner of the page, click the current Onyx Portal account's name, then select the required account.
In the navigation pane, click Administration > Users tab.
The Administration page > Users tab displays the list of active user accounts from across all Onyx Portal accounts.
Users (n) – The count and list of user accounts in the selected Onyx Portal account.
User Email – The user's email address.
User Name – The user's name.
User Role – The user's role—Super Admin, Admin, Viewer.
Network – The networks under the selected Onyx Portal customer account that the user has permission to manage.
Actions – Shortcut options to edit and delete the user account.
To search for a particular user account, in the Search field, enter your search term.
View User Accounts under the GXC Root Account
To view user accounts under the GXC Root account:
Switch to the GXC Root account.
To switch to the GXC Root account, in the upper-right corner of the page, click the current Onyx Portal account's name, then click Other Accounts > Select GXC Root.
To view all existing user accounts under the GXC Root account:
Click Administration > Users tab.
The Administration page > Users tab displays the list of active user accounts from across all Onyx Portal accounts.
Name – The user's name.
Role – The user's role—GXC Admin, Super Admin, Admin, Viewer.
Email – The user's email address.
Status – The user account's status—Verified, Verification Pending, Forgot Password.
Account Name – The Onyx Portal account that the user is associated with.
Parent Account Name – The parent account of the Onyx Portal account that the user is associated with.
Actions – Shortcut options to edit, delete, and suspend the user account.
To search for a particular user account, in the upper-right corner of the page, in the Search field, enter your search term.
To view user accounts under a particular GXC partner account:
Click Administration > Partners tab. The summary details of all GXC partner accounts are displayed.
Click the GXC partner account's name. The <partner name> page is displayed. The Own Users section lists the user accounts under the GXC selected partner account.
To view the user accounts under a particular customer account:
Click Administration > Customers tab. The list of customer accounts is displayed.
Click the customer account's name. The <customer name> page is displayed. The Own Users section lists the user accounts under the selected customer account.
Create User Accounts
This section describes creating the following types of user accounts:
Create direct user accounts:
Create Direct Super Administrator, Administrator, or Viewer User Accounts
Create GXC Administrator User Account
Create upstream IdP user accounts
Create Direct Super Administrator, Administrator, or Viewer User Accounts
To create a direct Super Administrator, Administrator, or Viewer user account under non-GXC Root accounts:
Switch to the required GXC partner or customer account.
To switch between Onyx Portal accounts, in the upper-right corner of the page, click the current Onyx Portal account's name.
In the navigation pane, click Administration > Users tab.
The Administration page > Users tab displays the list of active user accounts.
In the upper-right corner of the page, click Add User.
The Create User page is displayed.
Enter the following details:
User Email – (Required) The user's email address.
Invite user to manage the current Onyx Portal customer account – (Displayed only if the email ID is already associated with an existing user account in any other Onyx Portal customer account.) To invite the user to manage the current Onyx Portal customer account, select the check box.
User Name – (Required) The user's full name.
Role – (Required) The user's role. Select from Super Admin, Admin, Viewer.
Network – Click to select from the list of networks in the customer account, all or specific networks that the user must have access to manage. To remove access to a particular network, clear the corresponding checkbox. Default value: All Networks.
Use account-level idle session timeout setting – To inherit the GXC partner/customer account level user idle timeout setting, select the checkbox. To configure a custom value, clear the checkbox and enter a value from one of the following ranges.
5–59 minutes
1–23 hours
1–7 days
To save the user account, in the upper-right corner of the page, click Save User.
Create Upstream IdP Super Admin, Admin, and Viewer User Accounts
Upstream IdP users are users who authenticate and are managed via a customer's IdP service rather than being managed directly by the Onyx Portal. If a customer's IdP cannot release the user attributes required for SSO user authentication (onyxPortalTenantId and onyxPortalRole) to the Onyx IdP, user accounts for Onyx Portal users in the customer's organization are created in the Onyx Portal.
To create an upstream IdP Super Admin, Admin, or Viewer user account:
Switch to the required GXC partner or customer account.
To switch between Onyx Portal accounts, in the upper-right corner of the page, click the current Onyx Portal account's name.
In the navigation pane, click Administration > Users tab.
The Administration page > Users tab displays the list of active user accounts.
In the upper-right corner of the page, click Add Upstream IdP User.
The Create User page is displayed.
Enter the following details:
User Email – (Required) The user's email address.
Invite user to manage the current Onyx Portal customer account – (Displayed only if the email ID is already associated with an existing user account in any other Onyx Portal customer account.) To invite the user to manage the current Onyx Portal customer account, select the check box.
User Name – (Required) The user's full name.
Role – (Required) The user's role. Select from Super Admin, Admin, Viewer.
Network – Click to select from the list of networks in the customer account, all or specific networks that the user must have access to manage. To remove access to a particular network, clear the corresponding checkbox. Default value: All Networks.
To save the user account, in the upper-right corner of the page, click Save User.
Edit User Accounts
This section applies to editing both direct and upstream IdP user accounts under non-GXC Root accounts.
To edit a user account under non-GXC Root accounts:
Switch to the required GXC partner or customer account.
To switch between Onyx Portal accounts, in the upper-right corner of the page, click the current Onyx Portal account's name.
In the navigation pane, click Administration > Users tab.
The Administration page > Users tab > Users section displays the list of active user accounts.
For the user account that you want to edit, in the Actions column, click the corresponding ⋮ (options) icon, then click Edit.
The Edit User Access page is displayed.
Edit the user's name or allowed networks as required.
User Email – (View-only field) The user's email address.
User Name – (Required) The user's name.
Role – (View-only field) The user's role.
Network – Click to select from the list of networks in the customer account, all or specific networks that the user must have access to manage. To remove access to a particular network, clear the corresponding checkbox. Default value: All Networks.
Use account-level idle session timeout setting – To inherit the GXC partner/customer account level user idle timeout setting, select the checkbox. To configure a custom value, clear the checkbox and enter a value from one of the following ranges.
5–59 minutes
1–23 hours
1–7 days
To save your edits, in the upper-right corner of the page, click Save User.
To edit user accounts under the GXC Root account:
Switch to the GXC Root account.
To switch to the GXC Root account, in the upper-right corner of the page, click the current Onyx Portal account's name, then click Other Accounts > Select GXC Root.
In the navigation pane, click Administration > Users tab.
The Administration page > Users tab displays the list of active user accounts.
For the user account that you want to edit, in the Actions column, click the corresponding ⋮ (options) icon, then click Edit.
The Edit User Access page is displayed.
Edit the user's name as required.
User Email – (View-only field) The user's email address.
User Name – (Required) The user's name.
Role – (View-only field) The user's role.
Use account-level idle session timeout setting – To inherit the GXC partner/customer account level user idle timeout setting, select the checkbox. To configure a custom value, clear the checkbox and enter a value from one of the following ranges.
5–59 minutes
1–23 hours
1–7 days
To save your edit, in the upper-right corner of the page, click Save User.
Reset User MFA Secrets
If a user's mobile phone is compromised or lost, and the user's MFA backup codes are unavailable or exhausted, you can reset the user's MFA secrets. Resetting a user's MFA secrets is equivalent to deleting the user's MFA registration, allowing the user to set up MFA again as if for a new user.
To reset a user's MFA secrets:
Switch to the required GXC partner or customer account.
To switch between Onyx Portal accounts, in the upper-right corner of the page, click the current Onyx Portal account's name.
In the navigation pane, click Administration > Users tab.
The Administration page > Users tab displays the list of active user accounts.
For the user account that you want to reset MFA secrets, in the Actions column, click the corresponding ⋮ (options) icon, then click Reset MFA Secrets.
A confirmation dialog box is displayed.
To confirm resetting the user's MFA secrets, click Yes.
Suspend User Accounts
To suspend a user account:
Switch to the required Onyx Portal account.
To switch between Onyx Portal accounts, in the upper-right corner of the page, click the current Onyx Portal account's name, then select the required account.
In the navigation pane, click Administration > Users tab.
The Administration page > Users tab displays the list of active user accounts.
For the user account that you want to suspend, in the Actions column, click the corresponding ⋮ (options) icon, then click Suspend Account.
A confirmation dialog box is displayed.
To confirm, click Yes.
The user account is suspended.
Activate Suspended User Accounts
To activate a suspended user account:
Switch to the required Onyx Portal account.
To switch between Onyx Portal accounts, in the upper-right corner of the page, click the current Onyx Portal account's name, then select the required account.
In the navigation pane, click Administration > Users tab.
The Administration page > Users tab displays the list of active user accounts.
For the suspended user account that you want to activate, in the Actions column, click the corresponding ⋮ (options) icon, then click Activate Account.
A confirmation dialog box is displayed.
To confirm, click Yes.
The user account is activated.
Delete User Accounts
To delete a user account from an Onyx Portal account:
Switch to the required Onyx Portal account.
To switch between Onyx Portal accounts, in the upper-right corner of the page, click the current Onyx Portal account's name, then select the required account.
In the navigation pane, click Administration > Users tab.
The Administration page > Users tab displays the list of active user accounts.
For the user account that you want to delete, in the Actions column, click the corresponding ⋮ (options) icon, then click Delete.
A confirmation dialog box is displayed.
To confirm, click Yes.
The user account is deleted.
View Onyx Portal Operations Audit Logs
The Onyx Portal supports audit logging of important Onyx Portal user operations, such as user log on and log out, all create, update, and delete operations, software upgrades, equipment restarts, log and cert file downloads, etc.
The audit logs are retained for a period of 60 days and can be downloaded as a .csv file.
The audit logs record details include the operation, the timestamp at which the operation occurred, the responsible user, client IP address, operation's category and sub-category, operation's status, and so on.
To view the Onyx Portal Operations Audit Logs:
Switch to the GXC Root account.
To switch to the GXC Root account, in the upper-right corner of the page, click the current Onyx Portal account's name, then click Other Accounts > Select GXC Root.
In the navigation pane, click Administration > Operations Audit Logs tab.
The Administration page > Operations Audit Logs tab displays the list of Onyx Portal Operations Audit Logs for the selected duration and customer account.
Audit Logs (n) – The total number of audit logs.
Timestamp – The timestamp at which the operation occurred.
Email – The email address of the user responsible for the operation. To filter logs for a particular user, in the Search Email box, enter the user's email address.
Operation Name – The operation's name—Post, Put, Delete. To filter logs based on operation name, in the dropdown select the required operation name.
Operation Category – The operation's category. To filter logs based on operation category, in the dropdown select the required operation category.
Operation Sub-Category – The operation's subcategory. To filter logs based on operation sub-category, in the dropdown select the required operation sub-category.
Operation Status – The operation's status—Success, Failure, Blank. To filter logs based on operation status, in the dropdown select the required operation status.
Client IP – The client IP address from which the operation occurred.
Request Details – Click
(view details) to view the object's details. The Details dialog box displays the object's details.Request Object – If available, click
(view details) to view the request details. The Details dialog box displays the object's request details.Additional Details – If available, click
(view details) to view additional object details, such as Onyx Edge or AP configuration, etc. The Details dialog box displays additional details.
By default, logs are displayed for all customer accounts. To view logs for a specific customer account, in the Tenant dropdown, select the customer account's name.
To change the selected duration for which logs are displayed, select the required from and to timestamps.
To search for logs using keywords, enter your search term in the Search keyword box.
To download the logs as a .csv file, click Download, and specify where to save the file.
Last updated
Was this helpful?