Print

VeloCloud SD-WAN 6.1 - Partner Guide - User Management-Partner Print

User Management - Partner

The User Management feature allows you to manage users, their roles, service permissions (formerly known as Role Customization), and authentication.

As a Partner, you can access this feature from the Partner portal, by navigating to Administration > User Management . The following screen is displayed:
Figure 1. User Management- Partner
The User Management window displays four tabs: Users, Roles, Service Permissions, and Authentication.
For additional information on each of these tabs, see:

Users

As a Partner, you can view the list of existing users and their corresponding details. You can add, modify, or delete a user. However, you cannot delete a default user.

To access the Users tab:

  1. Login to the Orchestrator as a Partner.
  2. In the Partner portal, select Administration from the top menu.
  3. From the left menu, select User Management. The Users tab is displayed by default.
    Figure 2. Users- Partner
  4. On the Users screen, you can perform the following activities:
    Table 1. Users Tab- Options and Descriptions
    Option Description
    New User Creates a new user. For additional information, see Add New User.
    Modify Allows you to modify the properties of the selected Partner user. You can change the Activation State of the selected Partner user. You can also modify the user details by selecting the username link.
    Delete Deletes the selected user. You cannot delete the default users.
    Download Select this option to download the details of all the users into a file in CSV format.
  5. The following are the other options available in the Users tab:
    Table 2. Users Tab- Additional Settings
    Option Description
    Search Enter a search term to search for the matching text across the table. Use the advanced search option to narrow down the search results.
    Columns Select the columns to be displayed or hidden on the page.
    Refresh Select to refresh the page to display the most current data.

Add New User

In the Partner portal of the Orchestrator, you can add new users and configure the user settings. To add a new user, perform the following steps:

  1. Login to the Orchestrator as a Partner.
  2. In the Partner portal, select Administration from the top menu.
  3. From the left menu, select User Management. The Users tab is displayed by default.
  4. Select New User.
    Figure 3. Add New User
  5. Enter the following details for the new user:
    Note: The Next button is activated only when you enter all the mandatory details in each section.
    Table 3. Add New User- Options and Descriptions
    Option Description
    General information Enter the required personal details of the user.
    Role Select a role that you want to assign to the user. For information on roles, see Roles.
    Edge Access Choose one of the following options:
    • Basic: Allows you to perform certain basic debug operations such as ping, tcpdump, PCAP, remote diagnostics, and so on.
    • Privileged: Grants you the root-level access to perform all basic debug operations along with Edge actions such as restart, deactivate, reboot, hard reset, and shutdown. In addition, you can access Linux shell.
    The default value is Basic.
  6. Select the Add another user check box if you wish to create another user, and then select Add User. The new user appears in the User Management > > Users page. Select the link to the user to view or modify the details. As a Partner Administrator, you can manage the Roles, Service Permissions, and API Tokens for the Partner users. For additional information on API Tokens, see API Tokens.
    Note: Partner Administrator should manually delete inactive Identity Provider (IdP) users from the Orchestrator to prevent unauthorized access via API Token.

API Tokens

The users can access the Orchestrator APIs using tokens instead of session-based authentication. As Partner Super User, you can manage the API tokens for your enterprise users. You can create multiple API tokens for a user.

Any user can create tokens based on the privileges they have been assigned to their user roles, except the Business Specialist users.

The users can perform the following actions, based on their roles:
  • Enterprise users can Create, Download, and Revoke tokens for them.
  • Partner Super users can manage tokens of Enterprise users, if the Enterprise user has delegated user permissions to the Partner.
  • Partner Super users can only create and revoke the tokens for other users.
  • Users can download only their own tokens and cannot download other users' tokens.

To manage the API tokens:

  1. Login to the Orchestrator as a Partner and navigate to Administration > User Management > Users .
  2. Select a user and select Modify or select the link to the username. Go to the API Tokens section.
    Figure 4. API Tokens
  3. Select New API Token.
    Figure 5. New Token
  4. In the New Token window, enter a Name and Description for the token, and then choose the Lifetime from the drop-down menu.
  5. Select Save. The new token is displayed in the API Tokens table. Initially, the status of the token is displayed as Pending. Once you download it, the status changes to Enabled.
  6. To deactivate a token, select the token, and then select Revoke API Token. The status of the token is displayed as Revoked.
  7. Select CSV to download the complete list of API tokens in a .csv file format.
  8. When the Lifetime of the token is over, the status changes to Expired.
    Note: Only the user who is associated with a token can download it and after downloading, the ID of the token alone is displayed. You can download a token only once. After downloading the token, the user can send it as part of the Authorization Header of the request to access the Orchestrator API.
  9. The following are the other options available in the API Tokens section:
    Table 4. API Tokens - Additional Settings
    Option Description
    Search Enter a search term to search for the matching text across the table. Use the advanced search option to narrow down the search results.
    Columns Select the columns to be displayed or hidden on the page.
    Refresh Select to refresh the page to display the most current data.
    The following example shows a sample snippet of the code to access an API. 
    curl -k -H "Authorization: Token <Token>" -X POST https://vco/portal/ -d '{ "id": 1, "jsonrpc": "2.0", "method": "enterprise/getEnterpriseUsers", "params": { "enterpriseId": 1 }}'

Roles

The Orchestrator consists of two types of roles.

Note: Starting from the 5.1.0 release, Functional Roles are renamed as Privileges, and Composite Roles are renamed as Roles.

The roles are categorized as follows:

  • Privileges – Privileges are a set of roles relevant to a service. A privilege can be tagged to the following services: SD-WAN and Global Settings. Users require privileges to carry out business processes. For example, a Customer support role in SD-WAN is a privilege required by an SD-WAN user to carry out various support activities. Every service defines such privileges based on its supported business functionality.
  • Roles – The privileges from various categories can be grouped to form a role. By default, the following roles are available for a Partner administrator:
    Table 5. Partner User Roles
    Role SD-WAN Service Global Settings Service
    Partner Standard Admin SD-WAN Partner Admin Global Settings Partner Admin
    Partner Security Admin SD-WAN Security Partner Admin Global Settings Partner Admin
    Partner Network Admin SD-WAN Partner Admin Global Settings Partner Admin
    Partner Superuser Full Access Full Access
    Partner Business Specialist SD-WAN Partner Business Global Settings Partner Business
    Partner Customer Support SD-WAN Partner Support Global Settings Partner Support

    If required, you can customize the privileges of these roles. For additional information, see Service Permissions.

As a Partner, you can view the list of existing roles and their corresponding descriptions. You can add a new role, clone an existing role, edit or delete a custom role. You cannot edit or delete a default role.

To access the Roles tab:

  1. Login to the Orchestrator as a Partner.
  2. Select Administration from the top menu.
  3. From the left menu, select User Management, and then select the Roles tab. The following screen appears:
    Figure 6. Roles- Partner
  4. On the Roles screen, you can perform the following activities:
    Table 6. Roles Tab- Options and Descriptions
    Option Description
    Add Role Creates a new custom role. For additional information, see Add Role.
    Edit Allows you to edit only the custom roles. You cannot edit the default roles. Also, you cannot edit or view the settings of a Superuser.
    Clone Role Creates a new custom role, by cloning the existing settings from the selected role. You cannot clone the settings of a Superuser.
    Delete Role Deletes the selected role. You cannot delete the default roles. You can delete only custom composite roles. Ensure that you have removed all the users associated with the selected role, before deleting the role.
    Download CSV Downloads the details of the user roles into a file in CSV format.
    Note: You can also access the Edit, Clone Role, and Delete Role options from the vertical ellipsis of the selected Role.
  5. Select the Open icon displayed before the Role link, to view additional details about the selected Role, as shown below:
    Figure 7. Open Icon
  6. Select the View Role link to view the privileges associated to the selected role for the following services:
    • Global Settings & Administration
    • SD-WAN
  7. The following are the other options available in the Roles tab:
    Table 7. Roles Tab- Additional Settings
    Option Description
    Search Enter a search term to search for the matching text across the table. Use the advanced search option to narrow down the search results.
    Columns Select the columns to be displayed or hidden on the page.
    Refresh Select to refresh the page to display the most current data.

Add Role

To add a new role for a Partner, perform the following steps:

  1. Login to the Orchestrator as a Partner.
  2. Select Administration from the top menu.
  3. From the left menu, select User Management, and then select the Roles tab.
  4. Select Add Role.
    Figure 8. Add Role
  5. Enter the following details for the new custom role:
    Table 8. Add Role- Options and Descriptions
    Option Description
    Role Details
    Role Name Enter a name for the new role.
    Role Description Enter a description for the role.
    Template Optionally, select an existing role as template from the drop-down list. The privileges of the selected template are assigned to the new role.
    Scope Select either Partner or Enterprise as the scope for the new role. A role with the Partner scope can be applied to Partner level Administrators for the current Partner. A role with the Enterprise scope appears in the role list for all of the Partner's Customers.
    Role Creation: The options in this section vary depending on the selected Scope.
    Global Settings & Administration These privileges provide access to user management and global settings that are shared across all services. Choosing one of the privileges is mandatory. By default, Global Settings MSP Support is selected for the Partner scope. For the Enterprise scope, Global Settings Enterprise Read Only is selected by default.
    SD-WAN These privileges provide the Partner or Enterprise Administrator with different levels of read and/or write access around SD-WAN configuration, monitoring, and diagnostics. You can optionally choose an SD-WAN privilege. The default value is No Privileges.
  6. Select Save Changes. The new custom role appears in the User Management > Roles page of the user, depending on the selected Scope. Select the link to the custom role to view the settings.

Service Permissions

Service Permissions allow an Administrator to granularly define actions (Read, Create, Update, and Delete) assigned to each Privilege (such as Cloud Security Service and Customer Segment configuration) within a Privilege Bundle.

Note:
  • Starting from the 5.1.0 release, Role Customization is renamed as Service Permissions.
  • Only an Operator Superuser can activate Role Customization for a Partner Superuser. If the Role Customization option is not available for you, contact your Operator.

When you customize a Service Permission, the changes impact the roles associated with it. For additional information, see the topic Roles.

The Service Permissions are applied to the privileges as follows:
  • The customizations done at the Enterprise level override the Partner or Operator level customizations.
  • The customizations done at the Partner level override the Operator level customizations.
  • Only when there are no customizations done at the Partner level or Enterprise level, the customizations made by the Operator are applied globally across all users in the Orchestrator.
Note: For information on user privileges, see the topic List of User Privileges.

To access the Service Permissions tab:

  1. Login to the Orchestrator as a Partner.
  2. Select Administration from the top menu.
  3. From the left menu, select User Management, and then select the Service Permissions tab. The following screen appears:
    Figure 9. Service Permissions - Partner
  4. On the Service Permissions screen, you can perform the following activities:
    Table 9. Service Permissions - Options and Descriptions
    Option Description
    Service Select the service from the drop-down menu. The available services are:
    • All
    • Global Settings
    • SD-WAN

    Custom service permissions, if any, associated with the selected service are displayed. By default, all of the custom service permissions are displayed.
    New Permission Allows you to create a new permission. For additional information, see the topic New Permission.
    Edit Allows you to edit the settings of the selected permission. You can also select the link to the Permission Name to edit the settings.
    Clone Allows you to create a copy of the selected permission.
    Publish Permission Applies the customization available in the selected package to the existing permission. This option modifies the privileges only at the current level. If there are customizations available at the Operator level or a lower level for the same role, then the lower level takes precedence.
    More Allows you to select from the following additional options:
    • Delete: Deletes the selected permission. You cannot delete a permission if it is already in use.
      Note: A permission can only be deleted if it is in a draft mode. The Delete option is deactivated for a published permission. If you want to delete a published permission, you must reset the permission to system default, which changes it to draft mode and activates the Delete option for the permission.
    • Download JSON: Downloads the list of permissions into a file in JSON format.
    • Upload Permission: Allows you to upload a JSON file of a customized permission.
    • Reset to System Default: Allows you to reset the current published permissions to default settings. Only the permissions applied to the privileges in the current level (Operator, Partner, or Enterprise) of the Orchestrator are reset to the default settings. If Operators or Customers have customized their privileges in the Partner or Enterprise level in the Orchestrator, those settings remain the same.

     

  5. The following are the other options available in the Service Permissions tab:
    Table 10. Service Permissions - Additional Settings
    Option Description
    Columns Select the columns to be displayed or hidden on the page.
    Note: The Role Associated column displays the Roles using the same Privilege Bundle.
    Refresh Select to refresh the page to display the most current data.
    Note: Service Permissions are version dependent, and a service permission created on an Orchestrator using an earlier software release will not be compatible with an Orchestrator using a later release. For example, a service permission created on an Orchestrator that is running Release 3.4.x does not work properly if the Orchestrator is upgraded to a 4.x Release. Also, a service permission created on an Orchestrator running Release 3.4.x does not work properly when the Orchestrator is upgraded to 4.x.x Release. In such cases, the user must review and recreate the service permission for the newer release to ensure proper enforcement of all roles.

New Permission

You can customize the privileges and apply them to the existing permission in the Orchestrator .

To add a new permission, perform the following steps:

  1. Login to the Orchestrator as a Partner.
  2. Select Administration from the top menu.
  3. From the left menu, select User Management, and then select the Service Permissions tab.
  4. Select New Permission. The following screen appears:
    Figure 10. New Permission
  5. Enter the following details to create a new permission:
    Table 11. New Permission - Options and Descriptions
    Option Description
    Name Enter an appropriate name for the permission.
    Description Enter a description. This field is optional.
    Scope Select Partner or Enterprise as the scope. A Partner can customize the permissions for Partners and Customers.
    Service Select a service from the drop-down menu. The available services are:
    • Global Settings
    • SD-WAN
    Privilege Bundle Select a privilege bundle from the drop-down menu. The privileges are populated depending on the selected Service.
    Privileges Displays the list of privileges based on the selected Privilege Bundle. You can edit only those privileges that are eligible for customization.

     

  6. Select Download CSV to download the list of all privileges, their description, and associated actions, into a file in CSV format.
  7. Select Save to save the new permission. Select Save and Apply to save and publish the permission.
    Note: The Save and Save and Apply buttons are activated only after you modify the permissions.
    The new permission is displayed on the Service Permissions page.

List of User Privileges

This section lists all the role privileges available in the Partner portal of the Orchestrator.

The columns in the table indicate the following:
  • Allow Privilege – Do the privileges have allow access?
  • Deny Privilege – Do the privileges have deny access?
  • Customizable – Is the privilege available for customization in the Service Permissions tab?
Table 12. List of User Privileges
Feature Name of the Privilege Description Allow Privilege Deny Privilege Customizable
Manage Customers Create Customer Grants ability to view and manage Customers, from the Partner or Operator level Yes No No
  Read Customer
  Update Customer Yes Yes
  Delete Customer No No
  Manage Customer
Partner Events Create Partner Event Grants access to view Partner events Yes No No
  Read Partner Event Yes Yes
  Update Partner Event No No
  Delete Partner Event
  Manage Partner Event
Partner Admins Create Partner User Grants access to view and configure Partner administrators Yes No No
  Read Partner User Yes Yes
  Update Partner User No No
  Delete Partner User
  Manage Partner User
Partner Admins > API Tokens Create Partner Token Grants ability to view and manage operator authentication tokens Yes No No
  Read Partner Token
  Update Partner Token
  Delete Partner Token
  Manage Partner Token
Service Permissions Create Service Permissions Package Grants access to manage Service Permissions packages Yes No No
  Read Service Permissions Package
  Update Service Permissions Package
  Delete Service Permissions Package
  Manage Service Permissions Package
Partner Overview Update Partner Grants access to view and Partners Yes No No
Partner Overview > Other Settings Read User Agreement Grants access to configure the customer user agreement feature Yes No No
  Update User Agreement
Partner Settings Read Partner Delegation Grants ability to view and edit the delegation of Partner privileges to the Operator Yes No No
Partner Settings > General Information > Privacy Settings Read Customer Delegation Grants ability to view and manage the delegation of privileges from the customer to Partners or the Operator Yes Yes Yes
  Update Customer Delegation No
Partner Settings > Authentication Create Partner Authentication Grants ability to view and edit Partner authentication mode and associated configuration Yes No No
  Read Partner Authentication
  Update Partner Authentication
  Delete Partner Authentication
  Manage Partner Authentication
Partner Settings > Authentication > API Tokens Create Partner Token Grants ability to view and manage operator authentication tokens Yes No No
  Read Partner Token
  Update Partner Token
  Delete Partner Token
  Manage Partner Token
Edge Licensing Create License Grants ability to view and manage Edge licensing Yes No No
  Read License Yes Yes
  Update License
  Delete License No No
  Manage License
Gateway Pools Gateways Gateway Diagnostic bundles Create Gateway Grants ability to view and manage Gateways, from the Partner or Operator level Yes Yes Yes
Read Gateway
Update Gateway
Delete Gateway
Manage Gateway
View Tab Gateway List Grants ability to view the Gateway list tab No Yes Yes
Gateway Diagnostic Bundles > Download Diagnostic Bundles Download Gateway Diagnostics Grants ability to download Gateway Diagnostics No Yes Yes
VeloCloud Support Access Role Create Partner Delegation Grants ability to view and edit the delegation of Partner privileges to the Operator Yes No No
  Read Partner Delegation
  Update Partner Delegation
  Delete Partner Delegation
  Manage Partner Delegation

When the corresponding user privilege is denied, the Orchestrator window displays the 404 resource not found error.

Below table provides a list of customizable feature privileges:
Table 13. List of Customizable Privileges
Navigation Path in the Enterprise Portal Name of the Tab Name of the Privilege Description
Configure > Edges > Select Edge Overview Assign Edge Profile Grants ability to assign a Profile to Edges
Configure > Edges > Select Edge Firewall Configure Edge Firewall Logging Grants ability to configure Edge level firewall logging
Configure > Profiles > Select Profile Firewall Configure Profile Firewall Logging Grants ability to configure Profile level firewall logging
Diagnostics > Remote Actions Select Edge > Deactivate Deactivate Edge Grants ability to reset the device configuration to its factory default state
Global Settings > Enterprise Settings > Information Privacy Settings > SD-WAN PCI Enforce PCI Compliance Deny PCI Operations Denies access to sensitive Customer data including PCAPs, etc. on the Edges and Gateways, for all users including Arista Support
Diagnostics > Diagnostic Bundles Select Edge > Download Bundle Download Edge Diagnostics Grants ability to download Edge Diagnostics
Gateway Management > Diagnostic Bundles Select Gateway > Download Bundle Download Gateway Diagnostics Grants ability to download Gateway Diagnostics
Configure > Profiles Duplicate Duplicate Customer Profile Grants ability to edit duplicate customer level Profiles
Configure > Segments / Configure > Profiles / Configure > Edges Segments drop-down menu Edit Tab Segments Grants ability to edit within the Segments tab
Configure > Edges > Select Edge Device Enable HA Cluster Grants ability to configure HA Clustering
Configure > Edges > Select Edge Device Enable HA Active/Standby Pair Grants ability to configure active/standby HA
Configure > Edges > Select Edge Device Enable HA VRRP Pair Grants ability to configure VRRP HA
Diagnostics > Remote Diagnostics Clear ARP Cache Remote Clear ARP Cache Grants ability to clear the ARP cache for a given interface
Diagnostics > Remote Diagnostics > Gateway Cloud Traffic Routing (drop-down menu) Remote Cloud Traffic Routing Grants ability to route cloud traffic remotely
Diagnostics > Remote Diagnostics DNS/DHCP Service Restart Remote DNS/DHCP Restart Grants ability to restart the DNS/DHCP service
Diagnostics > Remote Diagnostics Flush Flows Remote Flush Flows Grants ability to flush the Flow table, causing user traffic to be re-classified
Diagnostics > Remote Diagnostics Flush NAT Remote Flush NAT Grants ability to flush the NAT table
Diagnostics > Remote Diagnostics > LTE SIM Switchover LTE Switch SIM Slot
Note: This is for 610-LTE devices only.
 Remote LTE Switch SIM Slot Grants ability to activate the SIM Switchover feature. After the test is successful, you can check the status from Monitor > Edges > Overview tab
Diagnostics > Remote Diagnostics List Paths Remote List Paths Grants ability to view the list of active paths between local WAN links and each peer
Diagnostics > Remote Diagnostics List current IKE Child SAs Remote List current IKE Child SAs Grants ability to use filters to view the exact Child SAs you want to see
Diagnostics > Remote Diagnostics List current IKE SAs Remote List Current IKE SAs Grants ability to use filters to view the exact SAs you want to see
Diagnostics > Remote Diagnostics MIBs for Edge Remote MIBS for Edge Grants ability to dump Edge MIBs
Diagnostics > Remote Diagnostics NAT Table Dump Remote NAT Table Dump Grants ability to view the contents of the NAT table
Diagnostics > Remote Diagnostics Select Edge > Rebalance Hub Cluster Remote Rebalance Hub Cluster Grants ability to either redistribute Spokes in Hub Cluster or redistribute Spokes excluding this Hub
Diagnostics > Remote Diagnostics Select Edge (with SFP module) > Reset SFP Firmware Configuration Remote Reset SFP Firmware Configuration Grants ability to reset the SFP Firmware Configuration
Diagnostics > Remote Actions Reset USB Modem Remote Reset USB Modem Grants ability to execute the Edge USB modem reset remote action
Diagnostics > Remote Diagnostics Scan for Wi-Fi Access Points Remote Scan for Wi-Fi Access Points Grants ability to scan the Wi-Fi functionality for the SD-WAN Edge
Diagnostics > Remote Diagnostics System Information Remote System Information Grants ability to view system information such as system load, recent WAN stability statistics, monitoring services
Diagnostics > Remote Diagnostics VPN Test Remote VPN Test Grants ability to execute the Edge VPN test remote action
Diagnostics > Remote Diagnostics WAN Link Bandwidth Test Remote WAN link Bandwidth Test Grants ability to re-test the bandwidth of a WAN link
Diagnostics > Remote Actions Select Edge > Shutdown Shutdown Edge Grants ability to execute the Edge shutdown remote action
Service Settings > Alerts & Notifications Notifications > Email/SMS Update Customer SMS Alert Grants ability to configure SMS alerts at the customer level
Monitor > Edges > Select Edge Top Sources View Edge Sources Grants ability to view Monitor Edge Sources tab
Monitor > Firewall Firewall Logging View Firewall Logs Grants ability to view collected firewall logs
Monitor > Edges > Select Edge Top Sources View Flow Stats Grants ability to view collected flow statistics
Monitor > Firewall Logs Firewall Logs View Profile Firewall Logging Grants ability to view the details of firewall logs originating from Edges
Configure > Profiles Firewall View Stateful Firewall Grants ability to view collected flow statistics
Configure > Profiles Firewall tab > Configure Firewall > Syslog Forwarding View Syslog Forwarding Grants ability to view logs that are forwarded to a configured syslog collector
Operator portal > Gateway Management Gateways View Tab Gateway List Grants ability to view the Gateway list tab
Operator portal > Administration Operator Profiles View Tab Operator Profile Grants ability to view and configure settings within the Operator Profile menu tab
Monitor > Edges > Select Edge Top Sources View User Identifiable Flow Stats Grants ability to view potentially user identifiable flow source attributes

Authentication

The Authentication feature allows you to set the authentication mode for a Partner and an Enterprise user.

To access the Authentication tab:

  1. Login to the Orchestrator as a Partner and from the top menu, select Administration from the top menu.
  2. From the left menu, select User Management, and then select the Authentication tab. The following screen appears:
    Figure 11. Authentication- Partner
  3. Partner Authentication:
    Select one of the following Authentication modes:
    • Local: This is the default option and does not require any additional configuration.
    • Single Sign-On: Single Sign-On (SSO) is a session and user authentication service that allows users to log in to multiple applications and websites with one set of credentials. Integrating an SSO service with Orchestrator enables Orchestrator to authenticate users from OpenID Connect (OIDC)-based Identity Providers (IdPs).
      To enable Single Sign On (SSO) for Orchestrator, you must enter the Orchestrator application details into the Identity Provider (IdP). Select each of the following links for step-by-step instructions to configure the following supported IdPs:
      You can configure the following options when you select the Authentication Mode as Single Sign-on.
      Figure 12. Single Sign-on Mode

       

      Table 14. Single Sign-on Mode- Options and Descriptions
      Option Description
      Identity Provider Template From the drop-down menu, select your preferred Identity Provider (IdP) that you have configured for Single Sign On. This pre-populates fields specific to your IdP.
      Note: You can also manually configure your own IdPs by selecting Others from the drop-down menu.
      OIDC well-known config URL Enter the OpenID Connect (OIDC) configuration URL for your IdP. For example, the URL format for Okta will be: https://{oauth-provider-url}/.well-known/openid-configuration.
      Issuer This field is auto-populated based on your selected IdP.
      Authorization Endpoint This field is auto-populated based on your selected IdP.
      Token Endpoint This field is auto-populated based on your selected IdP.
      JSON Web Key Set URI This field is auto-populated based on your selected IdP.
      User Information Endpoint This field is auto-populated based on your selected IdP.
      Client ID Enter the client identifier provided by your IdP.
      Client Secret Enter the client secret code provided by your IdP, that is used by the client to exchange an authorization code for a token.
      Scopes This field is auto-populated based on your selected IdP.
      Role Type Choose one of the following two options:
      • Use default role
      • Use identity provider roles
      Role Attribute Enter the name of the attribute set in the IdP to return roles.
      Partner Role Map Map the IdP-provided roles to each of the Partner user roles.

      Select Update to save the entered values. The SSO authentication setup is complete in the Orchestrator.

  4. SSH Keys:

    You can create only one SSH Key per user. Select the User Information icon located at the top right of the screen, and then select My Account > SSH Keys to create an SSH Key.

    As a Partner, you can also revoke an SSH Key.

    Select the Refresh option to refresh the section to display the most current data.

    For additional information, see Configure User Account Details.

  5. Session Limits:
    Note: To view this section, an Operator user must navigate to Orchestrator > System Properties , and set the value of the system property session.options.enableSessionTracking to True.
    The following are the options available in this section:
    Table 15. Session Limits- Options and Descriptions
    Option Description
    Concurrent logins Allows you to set a limit on concurrent logins per user. By default, Unlimited is selected, indicating that unlimited concurrent logins are allowed for the user.
    Session limits for each role Allows you to set a limit on the number of concurrent sessions based on user role. By default, Unlimited is selected, indicating that unlimited sessions are allowed for the role.
    Note: The roles that are already created by the Partner in the Roles tab, are displayed in this section.
  6. Select Update to save the selected values.

Configure Azure Active Directory for Single Sign On

Ensure you have an Azure AD account to sign in.

To set up an OpenID Connect (OIDC)-based application in Microsoft Azure Active Directory (Azure AD) for Single Sign On (SSO), perform the following steps.

  1. Log in to your Microsoft Azure account as an Admin user. The Microsoft Azure home screen appears.
  2. To create a new application:
    1. Search and select the Azure Active Directory service.
      Figure 13. Azure Active Directory
    2. Go to App registration > New registration . The Register an application screen appears.
      Figure 14. Register an application
    3. In the Name field, enter the name for your Orchestrator application.
    4. In the Redirect URL field, enter the redirect URL that your Orchestrator application uses as the callback endpoint. In the Orchestrator application, at the bottom of the Configure Authentication screen, you can find the redirect URL link. Ideally, the Orchestrator redirect URL will be in this format: https://<Orchestrator URL>/login/ssologin/openidCallback.
    5. In the Redirect URL field, enter the redirect URL that your Orchestrator application uses as the callback endpoint. In the Orchestrator application, at the bottom of the Configure Authentication screen, you can find the redirect URL link. Ideally, the Orchestrator redirect URL will be in this format: https://<Orchestrator URL>/login/ssologin/openidCallback.
    6. Select Register. Your Orchestrator application will be registered and displayed in the All applications and Owned applications tabs. Make sure to note down the Client ID/Application ID to be used during the SSO configuration in Orchestrator.
    7. Select Endpoints and copy the well-known OIDC configuration URL to be used during the SSO configuration in Orchestrator.
    8. To create a client secret for your Orchestrator application, on the Owned applications tab, select your Orchestrator application.
    9. Go to Certificates & secrets > New client secret . The Add a client secret screen appears.
      Figure 15. Add a client secret
    10. Provide details such as description and expiry value for the secret and select Add.
      The client secret is created for the application. Note down the new client secret value to be used during the SSO configuration in Orchestrator.
    11. To configure permissions for your Orchestrator application, select your Orchestrator application and go to API permissions > Add a permission . The Request API permissions screen appears.
      Figure 16. Request API permissions
    12. Select Microsoft Graph and select Application permissions as the type of permission for your application.
    13. Under Select permissions, from the Directory drop-down menu, select Directory.Read.All and from the User drop-down menu, select User.Read.All.
    14. Select Add permissions.
    15. To add and save roles in the manifest, select your Orchestrator application and from the application Overview screen, select Manifest. A web-based manifest editor opens, allowing you to edit the manifest within the portal. Optionally, you can select Download to edit the manifest locally, and then use Upload to reapply it to your application.
      Figure 17. Manifest
    16. In the manifest, search for the appRoles array and add one or more role objects as shown in the following example and select Save.
      Note: The value property from appRoles must be added to the Identity Provider Role Name column of the Role Map table, located in the Authentication tab, in order to map the roles correctly.
      Sample role objects: 
      { "allowedMemberTypes": [ "User" ], "description": "Standard Administrator who will have sufficient privilege to manage resource", "displayName": "Standard Admin", "id": "18fcaa1a-853f-426d-9a25-ddd7ca7145c1", "isEnabled": true, "lang": null, "origin": "Application", "value": "standard" }, { "allowedMemberTypes": [ "User" ], "description": "Super Admin who will have the full privilege on Orchestrator", "displayName": "Super Admin", "id": "cd1d0438-56c8-4c22-adc5-2dcfbf6dee75", "isEnabled": true, "lang": null, "origin": "Application", "value": "superuser" }
      Note: Make sure to set id to a newly generated Global Unique Identifier (GUID) value. You can generate GUIDs online using web-based tools (for example, https://www.guidgen.com/), or by running the following commands:
      • Linux/OSX - uuidgen
      • Windows - powershell [guid]::NewGuid()
      Figure 18. Manifest
    17. Roles are manually set up in the Orchestrator, and must match the ones configured in the Microsoft Azure portal.
      Figure 19. App Roles
  3. To assign groups and users to your Orchestrator application:
    1. Go to Azure Active Directory > Enterprise applications .
    2. Search and select your Orchestrator application.
    3. Select Users and groups and assign users and groups to the application.
    4. Select Submit.

    You have completed setting up an OIDC-based application in Azure AD for SSO.

Configure Single Sign On in the Orchestrator.

Configure Okta for Single Sign On

Ensure you have an Okta account to sign in.

To support OpenID Connect (OIDC)-based Single Sign On (SSO) from Okta, you must first set up an application in Okta. To set up an OIDC-based application in Okta for SSO, perform the steps on this procedure.

  1. Log in to your Okta account as an Admin user. The Okta home screen appears.
    Note: If you are in the Developer Console view, then you must switch to the Classic UI view by selecting Classic UI from the Developer Console drop-down list.
  2. To create a new application:
    1. In the upper navigation bar, select Applications > Add Application . The Add Application screen appears.
      Figure 20. Add Application
    2. Select Create New App. The Create a New Application Integration dialog box appears.
    3. From the Platform drop-drop menu, select Web.
    4. Select OpenID Connect as the Sign on method and select Create. The Create OpenID Connect Integration screen appears.
      Figure 21. Create OpenID Connect Integration
    5. Under the General Settings area, in the Application name text box, enter the name for your application.
    6. Under the CONFIGURE OPENID CONNECT area, in the Login redirect URIs text box, enter the redirect URL that your Orchestrator application uses as the callback endpoint.
    7. In the Orchestrator application, at the bottom of the Configure Authentication screen, you can find the redirect URL link. Ideally, the Orchestrator redirect URL will be in this format: https://<Orchestrator URL>/login/ssologin/openidCallback
    8. Select Save. The newly created application page appears.
    9. On the General tab, select Edit and select Refresh Token for Allowed grant types, and select Save. Note down the Client Credentials (Client ID and Client Secret) to be used during the SSO configuration in Orchestrator.
      Figure 22. Application
    10. Select the Sign On tab and under the OpenID Connect ID Token area, select Edit.
    11. From the Groups claim type drop-down menu, select Expression. By default, Groups claim type is set to Filter.
    12. In the Groups claim expression textbox, enter the claim name that will be used in the token, and an Okta input expression statement that evaluates the token.
    13. Select Save. The application is setup in IDP. You can assign user groups and users to your Orchestrator application.
      Figure 23. Groups claim expression
  3. To assign groups and users to your Orchestrator application:
    1. Go to Application > Applications and select your Orchestrator application link.
    2. On the Assignments tab, from the Assign drop-down menu, select Assign to Groups or Assign to People. The Assign <Application Name> to Groups or Assign <Application Name> to People dialog box appears.
    3. Select Assign next to available user groups or users you want to assign the Orchestrator application and select Done. The users or user groups assigned to the Orchestrator application will be displayed.
      Figure 24. Groups tab
    You have completed setting up an OIDC-based application in Okta for SSO.
Configure Single Sign On in the Orchestrator.

Configure OneLogin for Single Sign On

Ensure you have an OneLogin account to sign in.

To set up an OpenID Connect (OIDC)-based application in OneLogin for Single Sign On (SSO), perform the steps below:

  1. Log in to your OneLogin account as an Admin user. The OneLogin home screen appears.
  2. To create a new application:
    1. In the upper navigation bar, select Apps > Add Apps .
    2. In the Find Applications text box, search for “OpenId Connect” or “oidc” and then select the OpenId Connect (OIDC) app. The Add OpenId Connect (OIDC) screen appears.
      Figure 25. Add OpenId Connect (OIDC)
    3. In the Display Name text box, enter the name for your application and select Save.
    4. On the Configuration tab, enter the Login URL (auto-login URL for SSO) and the Redirect URI that Orchestrator uses as the callback endpoint, and select Save.
      • Login URL- The login URL will be in this format: https://<Orchestrator URL>/<Domain>/ login/doEnterpriseSsoLogin. Where, <Domain> is the domain name of your Enterprise that you must have already set up to enable SSO authentication for the Orchestrator. You can get the Domain name from the Enterprise portal Administration > System Settings > General Information page.
      • Redirect URI's- The Orchestrator redirect URL will be in this format: https://<Orchestrator URL>/login/ssologin/openidCallback. In the Orchestrator application, at the bottom of the Authentication screen, you can find the redirect URL link.
      Figure 26. Application Details
    5. On the Parameters tab, under OpenId Connect (OIDC), double select Groups. The Edit Field Groups pop-up appears.
      Figure 27. Edit Field Groups
    6. Configure User Roles with value “--No transform--(Single value output)” to be sent in groups attribute and select Save.
    7. On the SSO tab, from the Application Type drop-down menu, select Web.
    8. From the Authentication Method drop-down menu, select POST as the Token Endpoint and select Save. Note down the Client Credentials (Client ID and Client Secret) to be used during the SSO configuration in Orchestrator.
      Figure 28. Application Type
    9. On the Access tab, choose the roles that will be allowed to login and select Save.
      Figure 29. Access tab
  3. To add roles and users to your Orchestrator application:
    1. Select Users and select a user.
    2. On the Application tab, from the Roles drop-down menu, on the left, select a role to be mapped to the user.
    3. Select Save Users.
    You have completed setting up an OIDC-based application in OneLogin for SSO.
Configure Single Sign On in the Orchestrator.

Configure PingIdentity for Single Sign On

Ensure you have a PingOne account to sign in.

To set up an OpenID Connect (OIDC)-based application in PingIdentity for Single Sign On (SSO), perform the steps on this procedure.

Note: Currently, Orchestrator supports PingOne as the Identity Partner (IDP); however, any PingIdentity product supporting OIDC can be easily configured.
  1. Log in to your PingOne account as an Admin user. The PingOne home screen appears.
  2. To create a new application:
    1. In the upper navigation bar, select Applications.
      Figure 30. My Applications
    2. On the My Applications tab, select OIDC and then select Add Application. The Add OIDC Application pop-up window appears.
      Figure 31. Add OIDC Application
    3. Provide basic details such as name, short description, and category for the application and select Next.
    4. Under AUTHORIZATION SETTINGS, select Authorization Code as the allowed grant types and select Next. Note down the Discovery URL and Client Credentials (Client ID and Client Secret) to be used during the SSO configuration in Orchestrator.
    5. Under SSO FLOW AND AUTHENTICATION SETTINGS, provide valid values for Start SSO URL and Redirect URL and select Next. In the Orchestrator application, at the bottom of the Configure Authentication screen, you can find the redirect URL link. Ideally, the Orchestrator redirect URL will be in this format: https://<Orchestrator URL>/login/ssologin/openidCallback. The Start SSO URL will be in this format: https://<Orchestrator URL>/<domain name>/login/doEnterpriseSsoLogin.
    6. Under DEFAULT USER PROFILE ATTRIBUTE CONTRACT, select Add Attribute to add additional user profile attributes.
    7. In the Attribute Name text box, enter group_membership and then select the Required checkbox, and select Next.
      Note: The group_membership attribute is required to retrieve roles from PingOne.
    8. Under CONNECT SCOPES, select the scopes that can be requested for your Orchestrator application during authentication and select Next.
    9. Under Attribute Mapping, map your identity repository attributes to the claims available to your Orchestrator application.
      Note: The minimum required mappings for the integration to work are email, given_name, family_name, phone_number, sub, and group_membership (mapped to memberOf).
    10. Under Group Access, select all user groups that should have access to your Orchestrator application and select Done. The application will be added to your account and will be available in the My Application screen.
    You have completed setting up an OIDC-based application in PingOne for SSO.
Configure Single Sign On in Orchestrator.
..