Skip to main content
Version: Next

Domains

Overview

In Redtrust, a domain defines the authentication method for a group of users to access the service. The available authentication methods depend on how users are configured to authenticate, as outlined in the table below. Multiple domains can be defined to accommodate multiple use cases. For example, a SAML domain could be created for an organization's users/groups from an IdP like Entra ID (formerly knows as Azure Active Directory) using the Windows Agent in attended mode, while a separate local users domain could be created to authenticate a Linux build server.

Authentication sourceAdmin consoleWindows agent (attended)Windows agent (unattended)Linux agent (attended)
Activation code
Entra ID✅*
Certificate users
LDAP✅*
Local users (Username/Password)
OAuth
SAML 2.0

* Users authenticate against the domain using their username and password.

General configuration options

You can access the domain creation wizard by navigating to Access > Domain and clicking on the New button. In the wizard you must define the domain's features.

OptionDescription
AliasDefines what users will use to reference this domain when logging in to the service. For example, with a local users domain, a user with the username of John would login to the domain with an alias name of myDomain by entering John@myDomain. For SAML and OAuth domains the Alias can match the email domain of the users. For example, for an organization with emails formatted first.last@companyname.com, the alias could be companyname.com.
TypeValid domain types include:
  • Activation code
  • Entra ID
  • Certificate users>
  • LDAP
  • Local users (Username & Password)
  • OAuth 2.0
  • SAML 2.0
.
Access to Personal AreaDefined whether the users of this domain can access their personal area.
See UI screenshot

Other configuration options appear when selecting a domain type.

OptionDescription
Concurrency Per UserSetting for the domain to allow a single user to authenticate into multiple agent sessions simultaneously. This can be useful for short lived build pipelines and service accounts.
Limit UsersThis field is optional. It's a limit on the number of users that a given domain can be configured with.
SSO LoginThis button allows users to go directly to the Identity Provider (IdP). This feature applies to both SAML and OAuth 2.0 domains. If needed, multiple domains can be configured this way, enabling authentication with multiple IdPs directly from the login page.

Entra ID and LDAP configuration

When choosing an Entra ID (formerly Active Directory) or LDAP type domain, new configuration options are immediately displayed in the window:

See UI screenshot

Active Directory configuration options

LDAP configuration options

OptionDescription
HostDefines the server address.
BaseBase DN from which the repository is visible to Redtrust. For example DC=Redtrust,DC=com.
FilterFilter used for user searches in the directory. The string FILTER_PARAM represents the search term. A typical filter:
(&(|(cn=*FILTER_PARAM*)(userPrincipalName=*FILTER_PARAM*)(sAMAccountName=*FILTER_PARAM*))(objectCategory=person)).
Example: Searching for User1 replaces FILTER_PARAM with User1.
Groups filter(Entra ID only) Filter used for group searches in the directory. The string FILTER_PARAM represents the search term. A typical filter:
(&(cn=*FILTER_PARAM*)(objectCategory=group)).
Query userUser to connect to the external directory.
PasswordPassword for the query user.
Secure connectionIndicates whether the connection to the Entra ID server uses HTTP (not secure) or HTTPS (secure) protocol.

Local users

See UI screenshot

OptionDescription
Minimum lengthThe minimum required length of passwords.
Use uppercaseRequire passwords to include uppercase characters.
Use numbersRequire passwords to include numeric characters.
Use symbolsRequire passwords to include special characters.
Password expirationThis option sets a number of months before a password expires.
Account lockout
  • No lockout: No limit on password attempts.
  • Temporary lockout: Set a configurable number of attempts and a time (in seconds) to temporarily lockout the account.
  • Permanent lockout: Set a configurable number of attempts before locking out the account.
An administrator must reset locked-out accounts.

OAuth

See UI screenshot

OptionDescription
General
Client IDApp identifier. Provided by your IdP.
Secret clientApp authentication key. Provided by your IdP.
Authorization URLEndpoint to login and consent. Provided by your IdP.
Token URLEndpoint to exchange for access token. Provided by your IdP.
User information URLEndpoint to fetch user data. Provided by your IdP.
Automatic provisioning of usersIf enabled, this setting imports a user's email, name, and group membership in Redtrust the first time the user authenticates against the IdP. If this setting isn't enabled, you need to manually populate these data fields for users.
Attribute mapping
NameThe value you have configured for the name attribute from your IdP.
Last nameThe value you have configured for the last name attribute from your IdP.
Use groupsEnable to have Redtrust use a user's group membership in the claim.
GroupsThe value you have configured for the groups attribute from your IdP.
EmailThe value you have configured for the email attribute from your IdP.
Use email as user identifierEnable this option if your organization uses the email attribute as the identifier for users instead of the username. Note: This option needs to be configured at the time of domain creation. It isn't possible to edit this property once a domain has been created.
UsernameThe value you have configured for the username attribute from your IdP. This option is only available if you don't enable Use email as user identifier.

SAML 2.0

See UI screenshot

OptionDescription
General
SP EntityIDThis value should be https://REDTRUST_DEPLOYMENT_URL/ALIAS_OF_YOUR_DOMAIN. For example, if the alias of your SAML domain is companyname.com this would be https://redtrustdeployment.com/companyname.com.
Automatic provisioning of usersIf enabled, this setting imports a user's email, name, and group membership in Redtrust the first time the user authenticates against the IdP. If this setting isn't enabled, you need to manually populate these data fields for users.
Login URL (HTTP-redirect)Redirects users to the IdP for login. Provided by your IdP.
Logout URL (HTTP-redirect)Redirects users to the IdP for logout. Provided by your IdP.
IDP X.509 certificate (for signature)Verifies the IdP's digital signatures. Provided by your IdP.
Attribute mapping
EmailThe value you have configured for the email attribute in the SAML assertion.
Case sensitive NameIDWhen enabled this setting treats the NameID field as case sensitive. Enabled by default.
NameThe value you have configured for the name attribute in the SAML assertion.
SurnameThe value you have configured for the surname attribute in the SAML assertion.
Use email as user identifierEnable this option if your organization uses the email attribute as the identifier for users instead of name or surnames. Note: this option needs to be configured at the time of domain creation. It's not possible to edit this property once a domain has been created. Most use cases will want to enable this setting.
ACS by indexDisabled by default. This property specifies how to indicate to the IdP (through the SAML authentication request) the URL that will consume the SAML assertion generated by the IdP.
If disabled, AssertionConsumerServiceURL will be added to the authentication request. If enabled, AssertionConsumerServiceIndex will be added in the request. In addition, you must configure the IdP so that the index 0 corresponds to the URL https://REDTRUST_DEPLOYMENT_URL/Auth/SamlConsumer.
GroupsGroups to which the user is assigned.
tip

You may see the error “User found, but doesn't belong to any roles” when attempting to log in to Redtrust after authenticating with the IdP. This is because every user accessing the admin console must be assigned a role and the authenticating user hasn't yet been assigned one by the Redtrust administrator. You can solve this by either having the system admin log in to Redtrust and assign this new user to a role or by using SAML groups to assign an entire group of users to a particular role. This allows those group members to automatically log in.

IdP URL configuration

Users can also be directed to the IdP login page, skipping the Redtrust login page by navigating to a URL with the below configuration. After authenticating, the user is sent back to the Redtrust admin console.

https://REDTRUST_URL/login?domain=DOMAIN_ALIAS

User configuration options

OptionDescription
UsernameUsername
  • Between 1 - 32 characters
  • Valid Characters are (A-Z), (a-z), (0-9), (-), (.), (_).
  • StatusDefaults to active. A user with an inactive status won't be able to login.
    NameName of the user.
    EmailThe email address for the user.
    PasswordUser password.
    User must change password on next logonDefines whether the user is prompted to change the password the next time they log on.

    Once the user is created, it appears in the Users tab after clicking a domain's row.

    Selecting the user will bring up additional properties about the user.

    Additional User PropertiesDescription
    Last certificate usageThe last date and time this user signed with a Redtrust certificate.
    LockedThis option is enabled when a user is locked out due to the local user domain password policy. The Redtrust administrator can toggle it to unlock the account.