GitLab Dedicated users and notifications

  • Tier: Ultimate
  • Offering: GitLab Dedicated

Add Switchboard users

Administrators can add Switchboard users to their GitLab Dedicated instance. There are two types of users:

  • Read only: Users can only view instance data.
  • Admin: Users can edit the instance configuration and manage users.

To add a new user to your GitLab Dedicated instance:

  1. Sign in to Switchboard.
  2. From the top of the page, select Users.
  3. Select New user.
  4. Enter the Email and select a Role for the user.
  5. Select Create.

An invitation to use Switchboard is sent to the user.

Manage notification preferences

You can specify whether you want to receive email notifications from Switchboard. You will only receive notifications after you:

  • Receive an email invitation and first sign in to Switchboard.
  • Set up a password and two-factor authentication (2FA) for your user account.

To manage your own email notification preferences:

  1. From any page, open the dropdown next to your user name.
  2. To stop receiving email notifications, select Toggle email notifications off.
  3. To resume receiving email notifications, select Toggle email notifications on.

You will see an alert confirming that your notification preferences have been updated.

Reset a Switchboard user password

To reset your Switchboard password, submit a support ticket. The support team will help you regain access to your account.

SMTP email service

You can configure an SMTP email service for your GitLab Dedicated instance.

To configure an SMTP email service, submit a support ticket with the credentials and settings for your SMTP server.

Configure single sign-on for Switchboard

Enable single sign-on (SSO) for Switchboard to integrate with your organization’s identity provider. Switchboard supports both SAML and OIDC protocols.

To configure SSO for Switchboard:

  1. Gather the required information for your chosen protocol (see the information required for SAML and OIDC).
  2. Submit a support ticket with the information.
  3. Configure your identity provider with the information GitLab provides.

These instructions apply only to SSO for Switchboard. For GitLab Dedicated instances, see SAML single sign-on for GitLab Dedicated.

SAML configuration

When requesting SAML configuration, you must provide:

InformationDescription
Metadata URLThe URL that points to your identity provider’s SAML metadata document. This typically ends with /saml/metadata.xml or is available in your identity provider’s SSO configuration section.
Email attribute mappingThe format your identity provider uses to represent email addresses. For example, in Auth0 this might be http://schemas.auth0.com/email.
Attributes request methodThe HTTP method (GET or POST) that should be used when requesting attributes from your identity provider. Check your identity provider’s documentation for the recommended method.
User email domainThe domain portion of your users’ email addresses (for example, gitlab.com).

GitLab provides you with the following information to configure in your identity provider:

InformationDescription
Callback/ACS URLThe URL where your identity provider should send SAML responses after authentication.
Required attributesAttributes that must be included in the SAML response. At minimum, an attribute mapped to email is required.

If you require encrypted responses, GitLab can provide the necessary certificates upon request.

GitLab Dedicated does not support IdP-initiated SAML.

OIDC configuration

When requesting OIDC configuration, you must provide:

InformationDescription
Issuer URLThe base URL that uniquely identifies your OIDC provider. This URL typically points to your provider’s discovery document located at https://[your-idp-domain]/.well-known/openid-configuration.
Token endpointsThe specific URLs from your identity provider used for obtaining and validating authentication tokens. These endpoints are usually listed in your provider’s OpenID Connect configuration documentation.
ScopesThe permission levels requested during authentication that determine what user information is shared. Standard scopes include openid, email, and profile.
Client IDThe unique identifier assigned to Switchboard when you register it as an application in your identity provider. You’ll need to create this registration in your identity provider’s dashboard first.
Client secretThe confidential security key generated when you register Switchboard in your identity provider. This secret authenticates Switchboard to your IdP and should be kept secure.

GitLab provides you with the following information to configure in your identity provider:

InformationDescription
Redirect/callback URLsThe URLs where your identity provider should redirect users after successful authentication. These must be added to your identity provider’s allowed redirect URLs list.
Required claimsThe specific user information that must be included in the authentication token payload. At minimum, a claim mapped to the user’s email address is required.

Additional configuration details may be required depending on your specific OIDC provider.