SAML

Security Assertion Markup Language (SAML) is an XML-based standard for exchanging authentication and authorization data between security domains. The Service Provider must enroll with an Identity Provider and obtain an Issuer URL.

How it Works

An enterprise app contains a link to the AgileApps Cloud platform. When users who are logged into the enterprise app click that link, they are automatically logged into the AgileApps Cloud platform, without requiring additional authentication. For example, an employee of ABC Company logs into the corporate website, which includes a link to the AgileApps Cloud platform on the landing page. The user clicks the link and is automatically logged in, without requiring a second login.

The process is shown in the following diagram:

Here is an explanation of the steps:

	User	Your Organization's Web App	Platform	Identity Provider
1.	Logs in to a web app provided by your organization	Provides a link to the platform's SAML handler (generated by the platform when SAML is configured) Includes the desired platform target page as an argument in the link
2.	Clicks the link that goes to the SAML handler
3.			Sends an assertion to the identity provider
4.				Retrieves and validates the user's identity
5.				Sends the user's identity to the platform
6.			Redirects the user to the appropriate page.

Enabling SAML

1. Click > Administration > Account Management > Single Sign-On
2. Click the [Edit] button
3. For Single Sign-On Settings, choose SAML
4. Fill in the SAML Settings (below)
5. Click [Save]

The platform generates a link that goes to the SAML platform's SAML handler.

SAML Settings

SAML Settings for MS Azure

SAML Version

Choose Version 1.0 or Version 2.0

__TBD: Are both choices valid for Azure?__

Issuer

This field is ignored. Leave it empty.

SAML Third Party authentication URL

The URL used to authenticate a user or maintain a user's credentials.

• Syntax:The URL and Port Number must be specified using a FQDN or an IP address, for example:

• www.abc.com:9090
• 192.168.1.10
• abc.def.com

SAML Request Issuer URL

The URL used to access this tenant. Ex: http://yourCompany.agileappscloud.com

User Id Type

Choose Platform User ID

User Id Location

Choose Attribute

Attribute for User ID

Specify the Azure attribute that contains a platform User ID.

(An error occurs if the User ID attribute is empty, but does not match an existing user.)

Create New Users

Check this box to create a new user when the User ID attribute is empty.

When checked, additional options appear to specify default values and attribute-fields to use for the User's team, access profile, application, and role.

Issuer Certificate

Issuer certificate is used to sign and verify SAML messages. Requires a valid x509 issuer certificate.

• Choose one of the following options:

• Paste the Issuer Certificate in the text area

• Navigate to the Issuer Certificate section, then select and load a file containing the Issuer Certificate

SAML Settings for other Providers

SAML Version

Choose Version 1.0 or Version 2.0

Issuer

The identity provider. (A name or identifier of some sort.)

SAML Third Party authentication URL

The URL used to authenticate a user or maintain a user's credentials.

• Syntax:The URL and Port Number must be specified using a FQDN or an IP address, for example:

• www.abc.com:9090
• 192.168.1.10
• abc.def.com

SAML Request Issuer URL

The URL used to access this tenant. Ex: http://yourCompany.agileappscloud.com

__TBD: Does this apply for a non-Azure identify provider?__

User Id Type

Determines the type of identifier

• Choose UserId or Federated Id, where:

• UserId is the Record Id of the user that is logged in
• Federated ID acts as a user's authentication across multiple IT systems or organizations.

Learn more: Federated Identity

User Id Location

Specifies an attribute tag that defines the location of the User Id

• Choose Subject or Attribute

Attribute for User ID

Specify the Azure attribute that contains a platform User ID.

(An error occurs if the User ID attribute is empty, but does not match an existing user.)

__TBD: Does this apply for a non-Azure identify provider?__

Create New Users

Check this box to create a new user when the User ID attribute is empty.

When checked, additional options appear to specify default values and attribute-fields to use for the User's team, access profile, application, and role.

__TBD: Does this apply for a non-Azure identify provider?__

Issuer Certificate

Issuer certificate is used to sign and verify SAML messages. Requires a valid x509 issuer certificate.

• Choose one of the following options:

• Paste the Issuer Certificate in the text area

• Navigate to the Issuer Certificate section, then select and load a file containing the Issuer Certificate

Using SAML

To use single sign-on with SAML, you create links that go to the platform's SAML handler, passing the desired destination page as an argument.

To create a link to the platform in your enterprise app:

1. Copy the SAML link that was generated when SAML was configured.
2. Add a done= argument to the link that specifies the target page in the platform.

To create the done= argument:

1. Go to the standard initial page using Service?t=1&targetpage=ViewPort.jsp
2. Visit the page you want to target
3. Copy the URL from the browser's address bar
4. Edit the URL to remove https://{yourDomain}/networking/"
   What remains is the argument you'll pass. For example: pages/yourPage.jsp
5. URL encode the link

   Learn more: URL Encoding