Configure LDAP

To do this, follow these steps:

1. Log in to Service Portal as the administrator, using the following URL and user account:

   https://<Service Portal host name>:9000/org/Provider (Use "admin" as the user and "propel" as the password.)

2. Click Identity. The Organization List displays two out-of-box organizations: Consumer, and Provider.

3. Select Consumer.

4. On the Authentication tab, click Add Configuration.
5. Select the LDAP Configuration authentication type, and then click Create.

6. Configure the following settings.

   LDAP Server Information

   Item	Description	Example value
   Display Name	The display name for the LDAP server.	RC7
   Hostname	The fully-qualified LDAP server domain name (server.domain.com) or IP address.	10.255.255.255
   Port	The port used to connect to the LDAP server (by default, 389).	389
   SSL Connection	If the LDAP server is configured to require ldaps (LDAP over SSL), select the SSL Connection checkbox.	Not selected
   Base DN	Base distinguished name. The Base DN is the top level of the LDAP directory that is used as the basis of a search.	dc=maxcrc,dc=com
   User ID (Full DN)	The fully distinguished name of any user with authentication rights to the LDAP server. If the LDAP server does not require a User ID or password for authentication, this value can be omitted.	cn=Manager,dc=maxcrc,dc=com
   Password	Password of the User ID. If the LDAP server does not require a User ID or password for authentication, this value can be omitted.
   Retype Password	Retype the password of the User ID.

   LDAP Attributes

   Item	Description	Example value
   Full Name	The name of the LDAP attribute used to store the full name of the user. Often, this is cn or Display Name, but different LDAP directories may use different attributes. Contact your LDAP administrator to determine the proper Full Name. Default: cn	cn
   User Email	The name of the attribute of a user object that designates the email address of the user. The email address is used for notifications. If a value for this attribute does not exist for a user, the user does not receive email notifications. Default: mail	mail
   Group Membership	The name of the attribute(s) of a group object that identifies a user as belonging to the group. If multiple attributes convey group membership, the attribute names should be separated by a comma. Default: member,uniqueMember	memberOf
   Manager Identifier	The name of the attribute of a user object that identifies the manager of the user. Default: manager	manager
   Manager Identifier Value	The name of the attribute of a user object that describes the value of the Manager Identifier's attribute. For example, if the value of the Manager Identifier attribute is a distinguished name (such as cn=John Smith, ou=People, o=xyz.com) then the value of this field could be dn (distinguished name). Or, if the Manager Identifier is an email address (such as admin@xyz.com) then the value of this field could be email. Default: dn	managedObjects
   User Avatar	LDAP attribute whose value is the URL to a user avatar image that is displayed for the logged-in user. If no avatar is specified, a default avatar image is used.	Empty value

   User login Settings

   Item	Description	Example value
   User Name Attributes	The name of the attribute of a user object that contains the username that will be used to log in. The value for this field can be determined by looking at one or more user objects in the LDAP directory to determine which attribute consistently contains a unique user name. Often, you will want a User Name Attribute whose value in a user object is an email address. Examples: userPrincipalName or sAMAccountName or uid	uid
   User Searchbase	The location in the LDAP directory where users' records are located. This location should be specified relative to the Base DN. If users are not located in a common directory under the Base DN, leave this field blank. Examples: cn=Users or ou=People	ou=Users
   User Search Filter	Specifies the general form of the LDAP query used to identify users during login. It must include the pattern {0}, which represents the user name entered by the user when logging in. The filter is generally of the form {<attribute>= 0}, with<attribute> typically corresponding to the value entered for User Name Attribute. Examples: userPrincipalName={0} or sAMAccountName={0} or uid={0}	uid={0}
   Search Option (Search Subtree)	When a user logs in, the LDAP directory is queried to find the user's account. The Search Subtree setting controls the depth of the search under User Searchbase. If you want to search for a matching user in the User Searchbase and all subtrees under the User Searchbase, make sure the Search Subtree checkbox is selected. If you want to restrict the search for a matching user to only the User Searchbase, excluding any subtrees, unselect the Search Subtree checkbox.	Not selected

7. Save the configuration.
8. Click Save.

There are two ways to create groups in Service Portal: synchronize groups from LDAP, or manually create groups in Service Portal.

Synchronize groups from LDAP

You are recommended to create groups in LDAP and then synchronize the groups to Service Portal.

To synchronize a group from LDAP, follow these steps:

1. Log in to Service Portal:

   https://<Service Portal host name>:9000/org/Provider (Use "admin" as the user and "propel" as the password.)

2. Click Identity. The Organization List displays two out-of-box organizations: Consumer, and Provider.
3. Select Consumer from the organization list.
4. On the Groups tab, click Add Group.

5. Enter the following information:

   • Group Name: Enter a name for the LDAP group. It can be the same name as the group name in LDAP or a different one.
   • Group Representation Type: Select LDAP Representation.
   • Distinguished Name: Enter a value according to your LDAP data hierarchy. For example: cn=<Group Name in LDAP>.ou=Groups
   • Authentication: Select the LDAP server you configured.

   The following figure shows an example.

   

6. Click Save. The Group is added to the Groups tab.

7. Repeat the steps for the rest of your LDAP groups.

Manually create groups in Service Portal

If you have no groups created in LDAP, you can manually create them in Service Portal. To do this, follow these steps:

1. Log in to Service Portal:

   https://<Service Portal host name>:9000/org/Provider (Use "admin" as the user and "propel" as the password.)

2. Click Identity. The Organization List displays two out-of-box organizations: Consumer, and Provider.
3. Select Consumer from the organization list.
4. On the Groups tab, click Add Group.

5. Enter the following values:

   • Group Name: enter a name. For example: Administrators.
   • Group Representation Type: Select Database Representation.
   • Associated Users: Leave this field empty, as there are no users available to add at this point.

6. Click Save. The group is added to the Groups tab.

7. Repeat the steps to add more groups as needed.

   Note Do not log out. Continue with associating the groups to user roles.

After the groups are created, associate the groups to user roles. To do this, follow these steps:

1. On the Consumer organization details page, click Permissions.

   Note Service Portal provides two out-of-box roles: Consumer, and Organization Administrator. You can create more roles if needed. For details, see the Service Portal Admin Help.

2. Determine the user role to which you want to associate the group. For example, you may want to associate the Administrators group you created to the Organization Administrator user role.
3. Click Add Group under the user role to which you want to associate the group.

4. Select the group and click Save. The group is associated to the user role.

   Note Do not log out. Continue with adding the groups as impersonation groups.

Members of a organization's group can request catalog items on behalf of members in a different group within the organization. This capability is called request on behalf (RoB). This task is needed to enable the RoB capability for the groups.

To do this, follow these steps:

1. Click the Impersonation tab.
2. Click Add Group.
3. Select a group you created, and then click Save.
4. Repeat the steps for the rest of the groups.
5. Log out of Service Portal.

To do this, follow these steps:

1. Log in to Service Portal with an LDAP user account:

   https://<Service Portal host name>:9000/org/Consumer (Use an LDAP user account: for example, "falcon" as the user and "1Qaz2wsx" as the password.)

   If you are successfully logged in, your LDAP configuration is working correctly.

2. Log out of Service Portal.

The user (falcon) is now created in Service Portal. You can add it to a group now.

To do this, follow these steps:

1. Log in to Service Portal:

   https://<Service Portal host name>:9000/org/Provider (Use "admin" as the user and "propel" as the password.)

2. Add LDAP users to each group.

   To add LDAP user to a group, follow these steps:

   1. Click Identity. The Organization List displays two out-of-box organizations: Consumer, and Provider.
   2. Select Consumer from the organization list.
   3. On the Groups tab, select a group that you created, and then click the Edit icon.
   4. Click the Associated Users field, select a user (for example, falcon) from the list, and then click Add User. The LDAP user is added to the group.
   5. Repeat the steps to add more LDAP users to the group.
   6. Click Save.

   Note Repeat the steps for the rest of the groups.