Federation Guides › Partnership Federation Guide › Single Sign-on Configuration › Configure the SAML 2.0 Name ID Management Profile

Configure the SAML 2.0 Name ID Management Profile

The SAML 2.0 Name Identifier profile lets you de-provision an individual user from a federated partnership. You can remove a user from a partnership for any number of reasons. For example, an employee can have left the company, or no longer requires SSO capability with a Service Provider. You make the de-provisioning request through a client application program.

The following diagram illustrates the process of implementing the SAML 2.0 Name Identifier profile:

To use the Name ID Management profile to de-provision a user requires these steps:

1. Protect the Name Identifier Management Administration Web Service URL.
2. Configure a remote entity for Name ID Management.
3. Create a local entity.
4. Configure a partnership for Name ID Management.
5. Activate the partnership.
6. Enable Name ID Management requests.
7. Create a client application to interact with the Name Identifier Web Service.

Protect the Name Identifier Management Administration Web Service URL

Customer applications can use the Name Identifier Management Administration Web Service to request the de-provisioning of a user from a partnership. This web service implements the REST interface.

The URL for this service is /affwebservices/saml2nidws. You protect this URL using CA SiteMinder® Basic credentials. Include any users of this service in the user directories that are associated with the domain. CA SiteMinder® policy administrators are not included by default. You can add them manually to an associated directory.

Configure a Remote Entity for Name ID Management

The first step in creating a partnership that supports Name ID management is to define the remote and local partners, or entities. You can configure the entity manually, or you can import the XML metadata. These following steps are for manual configuration.

Follow these steps:

1. Navigate to Federation, Partnership Federation, Entities in the Administrative UI.
2. Click Create Entity.
3. Select Remote (either IdP or SP, depending on your implementation).
4. Click Next to configure specifics about the entity.
5. Enter the values for Entity ID and Entity Name (required).
6. Click Add Row on the line for Manage Name ID Service URLs.
7. Select the SOAP binding. A remote entity can specify another binding, which is imported, but unused.
8. Enter the Location URL, which specifies the URL of the Name ID Management service. This value is as follows:

   http://sp_server:port/affwebservices/public/saml2nidsoap

9. Leave the Response Location URL field blank. The Response Location URL for the SOAP binding is the same as the Location URL.
10. Select any supported Name ID formats from this list.
11. Complete any other fields that your implementation requires.
12. Click Next to confirm the entity configuration.
13. Click Finish.

Create a Local Entity

The first step in creating a partnership that supports Name Id Management is to define the remote and local partners, or entities. You can configure the entity manually, or you can import the XML metadata. See Federation Entity Configuration for information if you are unfamiliar with creating an entity in a partnership.

Important! You can select any Name ID format for user de-provisioning or de-linking. Dynamic account linking supports only Persistent Identifier format. In cases where you are implementing account linking and de-linking, select the Persistent Identifier Name ID format.

Configure a Partnership for Name ID Management

Enabling the Name ID Management feature requires some configuration for a new partnership or existing partnership. Either the local or the remote entity can initiate a request to de-provision a user from the partnership.

Follow these steps:

1. Navigate to the SSO and SLO dialog.
2. Configure the Authentication and SSO sections if they are not configured already.
3. Navigate to the Manage Name ID section.
4. Select SOAP in the MNI field.

   This selection enables Name ID Management in your partnership. See the online help for descriptions of these options.

5. (Required) Specify a SOAP timeout value. This value is the number of seconds the runtime waits until the request to the remote provider times out.

   Default: 60 seconds.

6. (Required) Specify the Retry Count, which is the number of times a background request is attempted before declaring failure. The default is 3.
7. (Required) Specify the Retry Boundary, which is the number of minutes in the interval between retries. The default is 15 minutes.
8. Specify the Notification URL if you have selected the Enable Notification option. This URL is the location where to send an HTTP notification to the customer application. The notification includes the status of the de-provisioning request after it has completed:
   • Status 1 for successful de-provisioning
   • Status 0 for unsuccessful de-provisioning
9. Specify the Notify Timeout, which is the number of seconds after which the request is considered timed out.

   Default 60 seconds.

10. Specify the Notification Authentication Type (NoAuth or Basic). If you select Basic, provide a user name and password.

Note: Select Delete Name ID or the Enable Notification option or both in the MNI section for the feature to function properly.

These steps complete the Manage Name ID configuration.

Activate the Partnership

See Partnership Activation for details.

Enable Name ID Management Requests

A Web Agent Option Pack internal component named the Asynchronous Requesting Processor handles all requests to the Name ID Management Service. Only one Web Agent Option Pack can have this service running at one time. In addition to settings in the Administrative UI, you enable Name ID Management processing by specifying settings in the AffWebServices.properties file in the following locations:

• SPS: <SECURE_PROXY_HOME>/Tomcat/webapps/affwebservices/WEB-INF/classes
• WA+WAOP: <WEB_AGENT_HOME>/affwebservices/WEB-INF/classes

The AffWebServices.properties file contains the following settings that are related to Name ID Management:

ProcessBackgroundNameIDOperations

Specifies whether this system processes Name ID operations.

Default: False

Important! Set this value to True to enable Name ID Management for the Option Pack or SPS.

BackgroundProcessingInterval

Specifies the number of seconds between times the asynchronous processor check for a Name ID request. You can modify this value.

Default: 60 seconds

If you upgrade your Option Pack or SPS, the installer adds these settings with their default values to the new properties file.

Create a Client Application to Interact with the Name Identifier Web Service

The content of the client application is implementation-dependent. To request the removal of a user, use the Name Identifier Management Administration Web Service. The web service implements the following two HTTP methods:

• POST — to initiate a de-provisioning request.
• GET — to poll the status of a request.

The methods adhere to the OData protocol. Details about these methods follow.

Terminate Federation Membership

An administrator can terminate the federated membership for a user by using the following URL:

POST http://<server+port>/affwebservices/saml2nidws/terminate

This asynchronous request creates a ManageNameID event in XPS.

The POST body includes the following values:

UserDN

Disambiguates the user, because there is no SMSession. An example DN for LDAP is uid=user0001,ou=Engineering,o=security.com.

OperationType

Indicates a particular use case. The valid values are:

• sp – indicates an idp wishing to terminate a Federation with a specific Service Provider.
• idp – indicates a Service Provider wishing to terminate a Federation with a specific Identity Provider.

ProviderID

Determines which providers are part of the operation. For the sp and idp values, the ProviderID identifies a remote provider. If the OperationType is ‘sp’, the ProviderID represents a remote Service Provider object. If the OperationType is ‘idp’, the ProviderID represents a remote Identity Provider object.

The information in the POST body of the request is in JSON or AtomPub format. The following example is in JSON format:

{
"UserDN":"uid=user0001,ou=Engineering,o=security.com",
"OperationType":"sp",
"ProviderID":"http://company.example.com/SPID"
}

This request returns the resource that represents this persisted object, for example:

http://<server+port>/affwebservices/saml2nidws/terminate(<XID>)

<XID> is the XPS XID of the created object. The client can use this URL to poll for changes to this object.

The request can also be in full AtomPub format as follows:

<?xml version="1.0" encoding="utf-8"?>
<entry xmlns="http://www.w3.org/2005/Atom" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata">
<title type="text"></title><author><name></name></author>
<category term="NameidProducer.terminate" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme"></category>
<content type="application/xml">
<m:properties>
<d:UserDN>uid=user0001,ou=Engineering,o=security.com</d:UserDN><d:ProviderID>http://company.example.com/SPID</d:ProviderID>
<d:OperationType>SP</d:OperationType>
</m:properties>
</content>
</entry>

The POST service sets the following HTTP return codes:

Poll for Status

An administrator can use this service to request status of the asynchronous request using the following URL:

GET http://<server+port>/affwebservices/saml2nidws/terminate(<XID>)

The URL used to poll for the resource status.

The response returns the status of the request, either PENDING, COMPLETED, or FAILED.

Important! Before you make this request, be sure that the CssChecking parameter in the Agent Configuration Object is set to NO. This setting avoids a potential conflict in syntax between OData and a cross-site scripting attack.

The GET service sets the following HTTP return codes: