All pages
Powered by GitBook
1 of 1

Loading...

How do I set up SSO?

SoftwareOne Marketplace has an SSO Authentication framework that integrates with existing identity provider tools, such as Azure AD and ADFS, and SAML-based tools, such as Okta and Ping. This topic describes how you can set up SSO with these tools.

Setting up SSO with SAML

Process

Setting up SSO with SAML involves the following steps:

  1. Provide IdP metadata to SoftwareOne - Provide SoftwareOne with basic metadata about your IdP. If your SSO tool requires the Assertion Consumer Service URL and Entity ID, contact SoftwareOne.

  2. SoftwareOne configures the client portal for your connection - SoftwareOne proceeds with a basic setup on the Client Portal IdP and provides you with {connection_name} to use for further configuration.

  3. You complete your IdP configuration - Finalize the setup on your side.

  4. Federation becomes active - All logins to the Client Portal for any of the specified IdP domains are federated out to your SAML-based IdP.

To set up SSO with SAML, SoftwareOne requires the following information:

  • IdP Domains (list of email domains, for example, @user.org for which authentication should be federated out to your IdP)

  • Sign In URL (HTTP-POST or HTTP-Redirect)

  • Sign out URL

Item
Details

The {connection_name} is a verbatim string that SoftwareOne provides after receiving your initial configuration settings.

Setting
Value

The Client Portal requires the following attributes via specified mappings:

Attribute
Mapping

The attributes must satisfy at least one mapping for all properties above. If your IdP provides values for the required attributes in different claims/namespaces, provide a list of claims to be used for all attributes above.

Make sure to provide the attribute values as they are without any modifications. URLs are sometimes changed by security software, for example, Proofpoint’s Targeted Attack Protection adds urldefense.com at the beginning of links.

To set up SSO with the Client Portal via Azure AD, you must complete the following steps. Once these steps are completed, SoftwareOne will enable SSO with your Azure AD.

Setting up SSO with Azure AD involves the following steps:

1

Register the Client Portal with Azure AD

  1. Sign in to the . If you have access to more than one tenant, select your account from the upper right. Set your portal session to the Azure AD tenant that you want.

  2. Search for and select Azure Active Directory.

Item
Detail
Setting
Value

The Client Portal queries the following basic profile attributes from Azure AD:

  • upn

  • azure_id

  • given_name

Setting up SSO with ADFS involves the following steps:

  1. Configure your ADFS server according to technical requirements.

  2. Provide ADFS metadata and IdP domains to SoftwareOne.

  3. SoftwareOne completes the ADFS setup.

To set up SSO with ADFS, SoftwareOne requires the following information:

  • ADFS Metadata Source (either the URL or the Federation Metadata file. The URL usually ends in /FederationMetadata/2007-06/FederationMetadata.xml )

  • IdP Domains (list of all email domains that must be authenticated through the federated ADFS server, for example, @customer.com. Usually 1 domain, but can also be multiple.)

Item
Detail
Setting
Value

By default, the Client Portal expects the following attributes from ADFS via the specified mappings:

LDAP Attribute
Outgoing Claim Type
Namespace

Setting up SSO with PingFederate involves the following steps:

  1. Provide sign-in certificates/IdP domains to SoftwareOne.

  2. SoftwareOne completes the SSO setup.

To set up SSO with PingFederate, SoftwareOne requires the following information:

  • PingFederate Server URL.

  • X509 signing certificate in the .pem or .cer format.

  • IdP Domains, including a list of all email domains that should be authenticated through the federated ADFS server (for example, @customer.com). Usually just one, but can also be multiple.

By default, the Client Portal requires the following attributes via the specified mappings:

Attribute
Mappings

The provided attributes must satisfy at least one mapping for all properties above. If your IdP provides values for the required attributes in different claims/namespaces, you can provide a list of claims to be used for all attributes above.

If an email domain is federated out to the user's identity provider, the Client Portal receives sign-in attempts from users who are not set up as Client Portal users.

In such cases, if authenticated users from a federated connection are not Client Portal users, their login to Client Portal will fail with an error message stating that their account is not set up and they don't have access.

X509 Signing Certificate (in the .pem or .cer format)

RSA-SHA256 (default) or RSA-SHA1

Sign Request Algorithm Digest

SHA256 (default) or SHA1

Signing Certificate Strength

2048 Bit RSA

IdP-Initiated SSO

Supported, but strongly discouraged

https://login.pyracloud.com/samlp/metadata?connection={connection_name}

Single Logout URL

https://login.pyracloud.com/logout

Single Login URL

We strongly discourage using IdP-Initiated SSO flows because they are vulnerable to . If possible, let the Client Portal initiate the sign-in (and federate out) when required.

http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress

given_name

http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname

Fallback URL: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name

family_name

http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname

Under Manage, select App registrations.
  • Select New Registration.

  • In Register an application, enter a meaningful application name to display to the users, for example, Client Portal.

  • In Supported account types, select Accounts in any organizational directory (Any Microsoft Entra directory - Multitenant).

  • In Redirect URI, select the Redirect URI type as Web, and enter your callback URL: https://login.pyracloud.com/login/callback.

  • Select Register.

  • 2

    Create a client secret

    SoftwareOne uses the client secret to interact with your Azure subscription on behalf of the created application.

    To create a secret:

    1. From the Overview page of the app, select Certificates & secrets > Client secrets > New client secret.

    2. Add a description for your client secret.

    3. Set the expiration date for the secret.

    4. Select Add.

    5. Make a note of the client's secret value. The value won't be accessible again after you leave this page.

    3

    Add API permissions

    To add permissions that allow read access to users and the user directory:

    1. From the App Overview page, select API permissions.

    2. Under Configured permissions, select Add a permission.

    3. Configure permissions for the Microsoft Graph API.

    4. After selecting the API, the Request API Permissions page is displayed.

    5. Enable the following permissions:

      • Users > User.Read

      • Directory > Directory.Read.All

    6. Select Add permissions to complete the process.

    4

    Send details to the Marketplace Platform Support

    Gather the following details and send them to marketplace-support@softwareone.com:

    Any sensitive information, such as SSO secrets or credentials, must be shared in encrypted form. Do not send sensitive data in plain text.

    If you need help encrypting or securely sharing this information, before sending the data. Our team can guide you through secure sharing options.

    Details
    Notes

    Application Client ID

    After we receive the information, we will finalize the setup. Once the setup is completed, the Client Portal automatically starts redirecting all users from the specified IdP domains to your Azure AD for federated authentication.

    family_name

  • nickname

  • tenantid

  • oid

  • email

  • name

  • http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name

    User-Principal-Name

    Name ID

    http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier

    Given-Name

    Given Name

    http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname

    Surname

    Surname

    http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname

    http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress

    given_name

    http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname

    Fallback URL:

    http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name

    family_name

    http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname

    Supported Protocol Bindings

    HTTP-POST & HTTP-Redirect

    SAML Authentication Requests signed

    Yes (by default)

    Entity ID

    urn:auth0:pyc:{connection_name}.

    Example: If your connection_name is demo_company, the Entity ID on Production will be

    urn:auth0:pyc:demo_company

    Assertion Consumer Service URL

    https://{idp_base_url}/login/callback?connection={connection_name}

    Example: If your connection_name is demo_company, the Assertion Consumer Service URL on Production will be: https://login.pyracloud.com/login/callback?connection=demo_company

    user_id

    http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier

    Fallback URL 1: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

    Fallback URL 2: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name

    name

    http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name

    Identity API

    Azure Active Directory (v1) (default) & Microsoft Identity Platform (v2).

    Protocol used for federated Sign-In

    OpenID Connect (default) or WS Federation.

    Application type

    Multitenant / Web

    Redirect URI

    https://{idp_base_url}/login/callback*

    The redirect URI on Production will be:

    https://login.pyracloud.com/login/callback

    Federation Metadata Discovery (Automated Certificate Rollover)

    Yes – if ADFS Metadata Source is provided as URL.

    Realm Identifier

    urn:auth0:{environment_name}

    For example, urn:auth0:pyc in Production.

    Endpoint

    https://{idp_base_url}/login/callback*

    The endpoint URL in Production will be: https://login.pyracloud.com/login/callback

    E-Mail-Addresses

    E-Mail Address

    http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress

    Display-Name

    user_id

    http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier

    Fallback URL 1: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn

    Fallback URL 2: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name

    name

    http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name

    Information required by the Client Portal

    Technical specification

    Capabilities

    Settings

    Attribute mappings

    Setting up SSO with Azure AD

    Process

    Technical specification

    Capabilities

    Settings

    Attribute mappings

    Setting up SSO with ADFS

    Process

    Information required by the Client Portal

    Technical specification

    Capabilities

    Settings

    Attribute mappings

    Setting up SSO with PingFederate

    Process

    Information required by the Client Portal

    Technical specification

    Attribute mappings

    Handling unknown or new users (ad hoc provisioning)

    Microsoft Azure Portal

    Sign Request Algorithm

    Metadata URL

    email

    Name

    email

    You can find the Application (client) ID on the overview page of the application created in .

    Application Client Secret

    Your client secret as created in .

    Microsoft Azure AD Domain

    Your Azure AD domain name. You can find this on your Azure AD directory's overview page in the Microsoft Azure portal.

    IdP Domains

    A list of all email domains that must be authenticated through the federated Azure AD, for example, @customer.com. Usually 1 domain, but can also be multiple.

    We recommend that you create a reminder to renew your client secret at least two weeks before it expires. Once you've created a new secret, provide the value to SoftwareOne so it can be updated in the system. If your client secret has expired or is no longer valid, you cannot sign in to the Client Portal using SSO.

    Enabling the Directory > Directory.Read.All permission is optional. If you want to benefit from future user auto-provisioning, turn it on. However, for SSO to work, this permission is not required.

    Login CSRF attacks
    contact Marketplace Platform Support
    Step 1: Register the Client Portal with Azure AD
    Step 2: Create a client secret