External user directories

You can connect FishEye to external user directories. This allows you to use existing users and groups stored in an enterprise directory, and to manage those users and groups in one place.

User management functions include:

  • Authentication: determining which user identity is sending a request to FishEye.
  • Authorization: determining the access privileges for an authenticated user.
  • User management: maintaining profile information in user's accounts.
  • Group membership: storing and retrieving groups, and group membership.

It is important to understand that these are separate components of a user management system. You could use an external directory for any or all of the above tasks.

There are several approaches to consider when using external user directories wth FishEye, described briefly below:

  • FishEye provides a "read-only" connection to external directories for user management. This means that users and groups, fetched from any external directory, can only be modified or updated in the external directory itself, rather than in FishEye.
  • Connecting FishEye to your external directory is not sufficient to allow your users to log in to FishEye. You must explicitly grant them access to FishEye in the global permission screen.
  • FishEye comes with an internal user directory, already built-in, that is enabled by default at installation.

License considerations

When connecting FishEye to an external directory, be careful not to allow access to FishEye by more users than your FishEye license allows. If the license limit is exceeded, users will not be able to use the application and FishEye will display a warning banner. You can manage which users have access to FishEye, using the global permission screen.

LDAP

You should consider connecting to an LDAP directory server if your users and groups are stored in an enterprise directory.

There are two common ways of using an external LDAP directory with FishEye:

FishEye is able to connect to the following LDAP directory servers:

  • Microsoft Active Directory
  • Apache Directory Server (ApacheDS) 1.0.x and 1.5.x
  • Apple Open Directory (Read-Only)
  • Fedora Directory Server (Read-Only Posix Schema)
  • Novell eDirectory Server
  • OpenDS
  • OpenLDAP
  • OpenLDAP (Read-Only Posix Schema)
  • Generic Posix/RFC2307 Directory (Read-Only)
  • Sun Directory Server Enterprise Edition (DSEE)
  • Any generic LDAP directory server

JIRA applications

You can delegate FishEye user and group management, as well as user authentication, to a JIRA application. This is a good option if you already use a JIRA application in your organization. Note that FishEye can only connect to a JIRA application server running JIRA 4.3 or later.

You should consider using Atlassian Crowd for more complex configurations with a large number of users. 

See Connecting to JIRA for user management for configuration instructions.

Crowd

You can connect FishEye to Atlassian Crowd for user and group management, as well as for user authentication.

Crowd is an application security framework that handles authentication and authorization for your web-based applications. With Crowd you can integrate multiple web applications with multiple user directories, with support for single sign-on (SSO) and centralized identity management. See the Crowd Administration Guide.

You should consider connecting to Crowd if you want to use Crowd to manage existing users and groups in multiple directory types, or if you have users of other web-based applications.

See Connecting to Crowd for configuration instructions.

Multiple directories

When FishEye is connected directly to multiple user directories, where duplicate user names and group names are used across those directories, the effective group memberships that FishEye uses for authorization can be determined using either of these two schemes: 

  • 'aggregating membership'
  • 'non-aggregating membership'. 

See Effective memberships with multiple directories for more information about these two schemes.

Note that:

  • Aggregating membership is used by default for new installations of FishEye.
  • Authentication, for when FishEye is connected to multiple directories, only depends on the mapped groups in those directories – the aggregation scheme is not involved at all.
  • The directory order is significant during the authentication of the user, in cases where the same user exists in multiple directories. When a user attempts to log in, the application will search the directories in the order specified, and will use the credentials (password) of the first occurrence of the user to validate the login attempt.
  • For inactive users, FishEye only checks if the user is active in the first (highest priority) directory in which they are found for the purpose of determining authentication. Whether a user is active or inactive does not affect how their memberships are determined.
  • When a user is added to a group, they are only added to the first writeable directory available, in priority order.
  • When a user is removed from a group, they are only removed from the group in the first directory the user appears in, when non-aggregating membership is used. With aggregating membership, they are removed from the group in all directories the user exists in.
  • When using Single Sign-On with Crowd and multiple Crowd directories:
    • signed-in users will be validated against the first Crowd directory the user is in
    • users that haven't signed in yet, but have a valid Crowd SSO cookie will be validated against all configured Crowd directories in order

 

A FishEye admin can change the membership scheme used by FishEye using the following commands:

  • To change to aggregating membership, substitute your own values for <username><password> and <base-url> in this command:

    curl -H 'Content-type: application/json' -X PUT -d '{"membershipAggregationEnabled":true}' -u <username>:<password> <base-url>/rest/crowd/latest/application 
  • To change to non-aggregating membership, substitute your own values for <username><password> and <base-url> in this command:

    curl -H 'Content-type: application/json' -X PUT -d '{"membershipAggregationEnabled":false}' -u <username>:<password> <base-url>/rest/crowd/latest/application 

Note that these operations are different from how you make these changes in Crowd. Note also that changing the aggregation scheme can affect the authorization permissions for your users, and how directory update operations are performed. 

Was this helpful?

Thanks for your feedback!

Why was this unhelpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport