Skip to main content

Authentication

This section describes how to configure user authentication and access control for Anaphora. Anaphora supports the authentication methods below.

Authentication methods​

MethodDescriptionBest For
LocalBuilt-in username/passwordSmall teams, testing
LDAPActive Directory integrationEnterprise Windows environments
SAMLSingle Sign-On via SAML 2.0Okta, Azure AD, OneLogin
OIDCOpenID Connect providersGoogle, Auth0, Keycloak
note

LDAP, SAML and OIDC need the Enterprise edition. The Free and Pro editions use Local authentication only. In the Free edition, all local users are system users.

Roles and permissions​

Anaphora uses role-based access control (RBAC).

User types​

Anaphora has two main user types: system users and normal users. System users have global access and manage the Anaphora instance. Normal users get access to specific spaces, with permissions for those spaces only.

User typeDescriptionMethods
System userFull global access, manage system settingsLocal, and LDAP, SAML and OIDC through system groups
Normal userAccess and manage resources within spacesAll

Space permissions​

Each user gets permissions in specific spaces:

PermissionDescription
AdminFull access within assigned spaces
Read WriteCreate and edit jobs, run reports
Read OnlyView reports and job status only

Permission details​

RightsSystem UserSpace AdminSpace Read WriteSpace Read Only
View reportsYesYesYesYes
View runsYesYesYesYes
Manage jobsYesYesYesNo
Manage delivery interfacesYesYesNoNo
Manage AI providersYesYesNoNo
Manage usersYesNoNoNo
Manage spacesYesNoNoNo
Global settingsYesNoNoNo
Export and import dataYesNoNoNo
Read authentication configYesNoNoNo
List and end sessionsYesNoNoNo
Read capture passwordsYesYesYesNo

Every action on jobs, templates, delivery interfaces and AI providers checks your access to the space that holds them.

  • Only a system user can read the authentication configuration (it holds the session secret and the LDAP, SAML and OIDC credentials), list and end sessions, and use the password and secret tools of the settings.
  • A user with Readonly access sees the jobs and templates without the login passwords of their captures.
Free edition

In the Free edition, every account has the System role.

Add user permissions​

Assign users and roles to spaces in Settings > System > Permissions. See the Spaces documentation for details.

System groups​

A local user has the system role when its System role is system. An LDAP, SAML or OIDC user has the system role when one of its roles is in the System groups of that method. Set System groups on the page of the method: Settings > System > Auth > LDAP, SAML or OIDC. For OIDC from the environment, use OIDC_SYSTEM_GROUPS (see OIDC).

  • The names are the roles that the method reads: the Groups parameter for SAML and OIDC, the Group name property for LDAP. They match whole and with case, never as a pattern, in the same way as space permissions match them.
  • Use names that are unique at the identity provider. For LDAP, use the group DN (Group name property dn): a directory can hold a second CN=Domain Admins in another OU, and anyone who can make a group there gets the role. For Keycloak, use a realm role or the full group path, because Keycloak sends admins for /a/admins and /b/admins alike unless its group mapper sends the full path.
  • Each method has its own list. A group with the same name at another identity provider gives nothing. A method that is not in Strategies gives nothing.
  • A change of System groups applies at the next request of each session, with no new login. The roles come from the login: a user that you remove from a group at the identity provider keeps the role until the session ends.
  • When System groups is empty (the default), no user of the method gets the system role.
  • /auth/userinfo shows the roles and the system_role of the user that is logged in.
Keep a local system user

Keep at least one local user with the system role. It is the way in when the identity provider is down or the list is wrong. Without one, the page that makes the first administrator opens again while single sign-on is off.

Next steps​