Skip to content

Latest commit

 

History

History
180 lines (122 loc) · 8.4 KB

index.md

File metadata and controls

180 lines (122 loc) · 8.4 KB
Raw
stage group info type
Manage
Authentication and Authorization
To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
reference

Enterprise users (PREMIUM SAAS)

Enterprise users have user accounts that are administered by an organization that has purchased a GitLab subscription.

Enterprise users are identified by the Enterprise badge next to their names on the Members list.

Provision an enterprise user

A user account is considered an enterprise account when:

  • A user without an existing GitLab user account uses the group's SAML SSO to sign in for the first time.
  • SCIM creates the user account on behalf of the group.

A user can also manually connect an identity provider (IdP) to a GitLab account whose email address matches the subscribing organization's domain. By selecting Authorize when connecting these two accounts, the user account with the matching email address is classified as an enterprise user. However, this user account does not have an Enterprise badge in GitLab, and a group Owner cannot disable the user's two-factor authentication.

Although a user can be a member of more than one group, each user account can be provisioned by only one group. As a result, a user is considered an enterprise user under one top-level group only.

Verified domains for groups

The following automated processes use verified domains to run:

Set up a verified domain

Prerequisites:

  • A custom domain name example.com or subdomain subdomain.example.com.
  • Access to your domain's server control panel to set up a DNS TXT record to verify your domain's ownership.
  • A project in the group.
  • You must have the Owner role in the top-level group.

Domain verification applies at the top-level group and to all subgroups and projects nested under that top-level parent group.

You cannot verify a domain for more than one group. For example, if a group named 'group1' has a verified domain named 'domain1', you cannot also verify 'domain1' for a different group named 'group2'.

Setting up a verified domain is similar to setting up a custom domain on GitLab Pages. However, you:

  • Do not need to have a GitLab Pages website.
  • Must link the domain to a single project, despite domain verification applying at the top-level group and to all nested subgroups and projects, because domain verification:
    • Is tied to the project you choose.
    • Reuses the GitLab Pages custom domain verification feature, which requires a project.
  • Must configure the TXT only in the DNS record to verify the domain's ownership.

In addition to appearing in the top-level group Domain Verification list, the domain will also appear in the chosen project. A member in this project with at least the Maintainer role can modify or remove the domain verification.

If needed, you can create a new project to set up domain verification directly under your top-level group. This limits the ability to modify the domain verification to members with at least the Maintainer role.

For more information on group-level domain verification, see epic 5299.

1. Add a custom domain for the matching email domain

The custom domain must match the email domain exactly. For example, if your email is [email protected], verify the example.com domain.

  1. On the left sidebar, at the top, select Search GitLab ({search}) to find your top-level group.
  2. Select Settings > Domain Verification.
  3. In the upper-right corner, select Add Domain.
  4. In Domain, enter the domain name.
  5. In Project, link to a project.
  6. In Certificate:
    • If you do not have or do not want to use an SSL certificate, leave Automatic certificate management using Let's Encrypt selected.
    • Optional. Turn on the Manually enter certificate information toggle to add an SSL/TLS certificate. You can also add the certificate and key later.
  7. Select Add Domain.

NOTE: A valid certificate is not required for domain verification. You can ignore error messages regarding the certificate if you are not using GitLab Pages.

2. Get a verification code

After you create a new domain, the verification code prompts you. Copy the values from GitLab and paste them in your domain's control panel as a TXT record.

Get the verification code

3. Verify the domain's ownership

After you have added all the DNS records:

  1. On the left sidebar, at the top, select Search GitLab ({search}) to find your group.
  2. Select Settings > Domain Verification.
  3. On the domain table row, Select Retry verification ({retry}).

Verify your domain

WARNING: For GitLab instances with domain verification enabled, if the domain cannot be verified for 7 days, that domain is removed from the GitLab project.

Notes:

  • Domain verification is required for GitLab.com users to be marked as enterprise users.
  • DNS propagation can take up to 24 hours, although it's usually a couple of minutes to complete. Until it completes, the domain shows as unverified.
  • Once your domain has been verified, leave the verification record in place. Your domain is periodically reverified, and may be disabled if the record is removed.
  • A valid certificate is not required for domain verification.

View domains in group

To view all configured domains in your group:

  1. On the left sidebar, at the top, select Search GitLab ({search}) to find your top-level group.
  2. Select Settings > Domain Verification.

You then see:

  • A list of added domains.
  • The domains' status of Verified or Unverified.
  • The project where the domain has been configured.

Manage enterprise users in a namespace

A top-level Owner of a namespace on a paid plan can retrieve information about and manage enterprise user accounts in that namespace.

These enterprise user-specific actions are in addition to the standard group member permissions.

Disable two-factor authentication

Introduced in GitLab 15.8.

Top-level group Owners can disable two-factor authentication (2FA) for enterprise users.

To disable 2FA:

  1. On the left sidebar, at the top, select Search GitLab ({search}) to find your group.
  2. Select Manage > Members.
  3. Find a user with the Enterprise and 2FA badges.
  4. Select More actions ({ellipsis_v}) and select Disable two-factor authentication.

Prevent users from creating groups and projects outside the corporate group

A SAML identity administrator can configure the SAML response to set:

  • Whether users can create groups.
  • The maximum number of personal projects users can create.

For more information, see the supported user attributes for SAML responses.

Bypass email confirmation for provisioned users

A top-level group Owner can set up verified domains to bypass confirmation emails.

Get users' email addresses through the API

A top-level group Owner can use the group and project members API to access users' information, including email addresses.

Troubleshooting

Cannot disable two-factor authentication for an enterprise user

If an enterprise user does not have an Enterprise badge, a top-level group Owner cannot disable or reset 2FA for that user. Instead, the Owner should tell the enterprise user to consider available recovery options.