Package: sentry-ldap-auth
sentry-ldap-authA Django custom authentication backend forSentry. This module extends the functionality ofdjango-auth-ldapwith Sentry specific features.FeaturesUsers created by this backend are managed users. Managed fields are not editable through the Sentry account page.Users may be auto-added to an Organization upon creation.PrerequisitesVersions 2.0 and newer require Sentry 8. For Sentry 7 support, usethe 1.1 releaseInstallationTo install, simply addsentry-ldap-authto yourrequirements.txtfor your Sentry environment (orpip install sentry-ldap-auth).ConfigurationThis module extends thedjango-auth-ldapand all the options it provides are supported (up to v1.2.x, at least).To configure Sentry to use this module, addsentry_ldap_auth.backend.SentryLdapBackendto yourAUTHENTICATION_BACKENDSin yoursentry.conf.py, like this:AUTHENTICATION_BACKENDS=AUTHENTICATION_BACKENDS+('sentry_ldap_auth.backend.SentryLdapBackend',)Then, add any applicable configuration options. Depending on your environment, and especially if you are running Sentry in containers, you might consider usingpython-decoupleso you can set these options via environment variables.sentry-ldap-auth Specific OptionsAUTH_LDAP_DEFAULT_SENTRY_ORGANIZATION=u'My Organization Name'Auto adds created user to the specified organization (matched by name) if it exists.AUTH_LDAP_SENTRY_ORGANIZATION_ROLE_TYPE='member'Role type auto-added users are assigned. Valid values in a default installation of Sentry are 'member', 'admin', 'manager' & 'owner'. However, custom roles can also be added to Sentry, in which case these are also valid.AUTH_LDAP_SENTRY_ORGANIZATION_GLOBAL_ACCESS=TrueWhether auto-created users should be granted global access within the default organization.AUTH_LDAP_SENTRY_SUBSCRIBE_BY_DEFAULT=FalseWhether new users should be subscribed to any new projects by default. Disabling
this is useful for large organizations where a subscription to each project
might be spammy.AUTH_LDAP_SENTRY_USERNAME_FIELD='uid'Specify which attribute to use as the Sentry username, if different from what the user enters on the login page. You can use this to prevent multiple accounts from being created when yourAUTH_LDAP_USER_SEARCHallows users to log in with different usernames (e.g.(|(uid=%(user))(mail=%(user)))). If multiple values exist for the attribute, the first value will be used.AUTH_LDAP_DEFAULT_EMAIL_DOMAIN='example.com'Default domain to append to username as the Sentry user's e-mail address when the LDAP user has nomailattribute.Sentry OptionsSENTRY_MANAGED_USER_FIELDS=('email','first_name','last_name','password',)Fields which managed users may not modify through the Sentry accounts view. Applies to all managed accounts.Example Configurationimportldapfromdjango_auth_ldap.configimportLDAPSearch,GroupOfUniqueNamesTypeAUTH_LDAP_SERVER_URI='ldap://my.ldapserver.com'AUTH_LDAP_BIND_DN=''AUTH_LDAP_BIND_PASSWORD=''AUTH_LDAP_USER_SEARCH=LDAPSearch('dc=domain,dc=com',ldap.SCOPE_SUBTREE,'(mail=%(user)s)',)AUTH_LDAP_GROUP_SEARCH=LDAPSearch('',ldap.SCOPE_SUBTREE,'(objectClass=groupOfUniqueNames)')AUTH_LDAP_GROUP_TYPE=GroupOfUniqueNamesType()AUTH_LDAP_REQUIRE_GROUP=NoneAUTH_LDAP_DENY_GROUP=NoneAUTH_LDAP_USER_ATTR_MAP={'name':'cn','email':'mail'}AUTH_LDAP_FIND_GROUP_PERMS=FalseAUTH_LDAP_CACHE_GROUPS=TrueAUTH_LDAP_GROUP_CACHE_TIMEOUT=3600AUTH_LDAP_DEFAULT_SENTRY_ORGANIZATION=u'My Organization Name'AUTH_LDAP_SENTRY_ORGANIZATION_ROLE_TYPE='member'AUTH_LDAP_SENTRY_GROUP_ROLE_MAPPING={'owner':['sysadmins'],'admin':['devleads'],'member':['developers','seniordevelopers']}AUTH_LDAP_SENTRY_ORGANIZATION_GLOBAL_ACCESS=TrueAUTH_LDAP_SENTRY_USERNAME_FIELD='uid'AUTHENTICATION_BACKENDS=AUTHENTICATION_BACKENDS+('sentry_ldap_auth.backend.SentryLdapBackend',)importlogginglogger=logging.getLogger('django_auth_ldap')logger.addHandler(logging.StreamHandler())logger.setLevel('DEBUG')